Skip to content

Commit

Permalink
Update project description in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sashachabin committed Dec 21, 2023
1 parent 53a3ad6 commit 18961e8
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,26 @@
# guides

📗 Ekaterinburg design guides website
📗 Website with Ekaterinburg design standards and guidelines

**[guides.ekaterinburg.city](https://guides.ekaterinburg.city)**

<img src="https://github.com/ekaterinburgdev/guides/assets/22644149/939e4a62-071e-4952-8510-45680795f237" width="65%" alt="" />

## About

Website with Ekaterinburg's design standards and guidelines. Frontend application visualize [UI components](https://github.com/ekaterinburgdev/guides/blob/ab6e1f408e0b9ffa2491ec0d73fe334247231b88/components/ManualPage/ManualPage.jsx#L70) from Notion's visual editor.
We are creating a unified knowledge base about Ekaterinburg that is easy to learn, develop, and enhance. Instead of the long formatting of cumbersome PDF files, standards authors write them in a user-friendly web interface, saving readers time on searching and downloading files.

<img src="https://github.com/ekaterinburgdev/guides/assets/22644149/87a01a9d-5d15-4fcf-b8a0-6259f434bb99" width="65%" alt="Notion's editor" />
For the first version of the guides, projects workis with [Notion](https://www.notion.so/) as CMS. Notion is a user-friendly editor with various features and [public API](https://developers.notion.com/).

Content from Notion is available in [Guides API](https://github.com/ekaterinburgdev/guides-api).
<img src="https://github.com/ekaterinburgdev/guides/assets/22644149/0e370dbd-37d0-4a4d-a91c-98d299f4f919" width="75%" alt="" />

## Features

- [x] Works with Notion databases in [guides-api](https://github.com/ekaterinburgdev/guides-api)
- [x] UI components for Notion content editor
- [x] Print pages (Ctrl+P)
- [ ] Search
- [ ] PDF generating

## Development

Expand Down

0 comments on commit 18961e8

Please sign in to comment.