Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Improve docs styles #461

Merged
merged 6 commits into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ To get started, check out our [quick start guide](https://ostis-ai.github.io/sc-
# make sure you're using python 3.12
pip3 install mkdocs mkdocs-material
mkdocs serve
# and open http://127.0.0.1:8000/ in your browser
# and open http://127.0.0.1:8002/ in your browser
```
</details>
- Full documentation, including:
Expand Down
4 changes: 4 additions & 0 deletions docs/_assets/main.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
p {
text-align: justify;
}

.todo {
background-color: #E06C6C;
border: 1px solid #AD3939;
Expand Down
1 change: 1 addition & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,7 @@ See documentation, to learn more about using new API.

### Changed

- Improve docs usability: add search, edit links, coping code blocks, logo, text justifying, move sections to header and other
- SCsParser no longer generates sc-arcs from types of sc-elements to sc-elements
- Allow multiple instances of `ScLogger` class
- Rename `ScLog` to `ScLogger`
Expand Down
Binary file modified docs/ostis-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 46 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
site_name: sc-machine
dev_addr: 127.0.0.1:8002
repo_url: https://github.com/ostis-ai/sc-machine
edit_uri: edit/main/docs/

extra_css:
- _assets/main.css

extra_javascript:
- _assets/scg.min.js
- _assets/main.js
Expand Down Expand Up @@ -53,14 +57,49 @@ nav:
- License: https://github.com/ostis-ai/sc-machine/blob/main/COPYING.MIT
- Changelog: changelog.md

theme: material
plugins:
- search:
lang: en
separator: '[\s\-\.]+'

theme:
name: material
favicon: ostis-logo.png
logo: ostis-logo.png
palette: # Defines color schemes for light and dark modes
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.instant # Enables instant loading of pages
- navigation.tracking # Automatically focuses active section in sidebar
- navigation.tabs # Adds top-level sections as tabs
- navigation.sections # Renders top-level sections as groups in sidebar
- navigation.expand # Expands all collapsible sections by default
- navigation.top # Adds a "back to top" button
- search.suggest # Displays search suggestions
- search.highlight # Highlights search terms on result page
- content.action.edit # Adds links to edit doc files
- content.tabs.link # Shares link when clicking on a tab
- content.code.copy # Adds a copy button to code blocks

markdown_extensions:
- admonition
- admonition # Allows creation of call-out boxes (e.g., notes, warnings)
- codehilite
- md_in_html
- pymdownx.highlight:
- md_in_html # Allows Markdown syntax inside HTML blocks
- pymdownx.highlight: # Enhances code block highlighting
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.details
- pymdownx.superfences
- pymdownx.inlinehilite # Enables inline code highlighting
- pymdownx.details # Allows creating collapsible elements
- pymdownx.superfences # Enables advanced fenced code blocks
Loading