tk/spectre.console
1
0
Fork 0
mirror of https://github.com/nsnail/spectre.console.git synced 2025-07-04 11:48:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

New doc theme (#387)

Browse Source
This commit is contained in:
Phil Scott
2021-04-24 16:20:59 -04:00
committed by GitHub
parent b568098d5e
commit 2a9fbb1ee9
145 changed files with 197984 additions and 8746 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/README.md
View File

@ -14,6 +14,12 @@ After the build is complete, you can navigate to [http://localhost:5080/spectre.
**Note that the site runs under a virtual directory.**
## Building the CSS
The documentation uses tailwind for the CSS. Committed to the repository is a large 4gb file with all possible styles at `assets/style.css`. This file is generated from the root files tailwind.config.js and tailwind.css. Any changes to the overall design style (e.g. colors, markdown styling, etc) can be made in these two files.
For production, `npm run build:tailwind` should be ran post Statiq build. This process will look at all the styles in the HTML and prune the tailwind file down to a much more manageable 30kb or so file.
## Editing Content
The documentation is written using [Markdown](https://www.markdownguide.org/basic-syntax/).