https://github.com/informaticsmatters/squonk-docs
Basic Squonk documentation for a customer site
https://github.com/informaticsmatters/squonk-docs
Last synced: about 1 month ago
JSON representation
Basic Squonk documentation for a customer site
- Host: GitHub
- URL: https://github.com/informaticsmatters/squonk-docs
- Owner: InformaticsMatters
- Created: 2018-12-19T15:50:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-04T15:50:44.000Z (over 7 years ago)
- Last Synced: 2025-06-04T13:48:59.150Z (about 1 year ago)
- Language: JavaScript
- Size: 4.41 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Base Squonk Docs
Source for the Squonk docs.
This repo can be cloned and then used as a base to develop your own version of the squonk documentation.
1. Clone this repo
2. Run the `init.sh` script with
```
sh init.sh
```
3. Make changes to the index.md, header.html and _config.yml as desired.
4. To add Cells make a copy of the base cell `/docs/cells/base/`. This should be given the title of the cell. Then edit the contents as desired. Run the indexer.py script, from any directory, using
```
python indexer.py
```
5. To add a Docs page, create a directory inside the `/docs/content/` directory with the name of the page. Inside, create a index.md file with the title as frontmatter. Add the new page to the yaml file `_data/docs.yml`.
6. When all changes have been made, run the `build.sh` script with
```
sh build.sh
```.
This can take some time due to a part of Jekyll that is unoptimised. If this build is to be deployed live, add the production argument.
```
sh build.sh production
```
This turns on minification and Google analytics if desired.
7. The output will be generated to the `_site` directory which can then be deployed.