2.7 KiB
Documentation
To start contributing to the Spectre.Console documentation, you will need the .NET Core SDK 3.1 or higher.
Running Preview Site
The documentation site uses Statiq, a static site generator. To build the documentation site run the following in a command-line terminal.
> Preview.ps1
After the build is complete, you can navigate to http://localhost:5080/spectre.console.
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.
Markdown files can be found under the following directories:
Editing Layout
Layout and styling can also be found in the input directory. Look for Sass, Css, and Images under the assets directory.
Custom Build Features
The documentation site has custom enhancements to Statiq located under the ./src directory.
License
MIT License
Copyright (c) 2020 Patrik Svensson, Phil Scott
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.