https://github.com/digitalnz/supplejack
Documentation Site Repo
https://github.com/digitalnz/supplejack
Last synced: 4 months ago
JSON representation
Documentation Site Repo
- Host: GitHub
- URL: https://github.com/digitalnz/supplejack
- Owner: DigitalNZ
- License: other
- Created: 2014-04-29T02:10:48.000Z (about 12 years ago)
- Default Branch: gh-pages
- Last Pushed: 2023-04-17T20:46:28.000Z (about 3 years ago)
- Last Synced: 2025-05-11T07:41:38.033Z (about 1 year ago)
- Language: CSS
- Homepage: http://digitalnz.github.io/supplejack/
- Size: 3.17 MB
- Stars: 4
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Supplejack docs](http://digitalnz.github.io/supplejack/)
These docs are built using Jekyll
## Using [Jekyll](http://jekyllrb.com/docs/home/)
To get started editing the documentation run the following commands
```bash
~ $ git clone git@github.com:/DigitalNZ/supplejack supplejack_docs
~ $ cd supplejack_docs
~ $ rbenv install $(cat .ruby-version)
~ $ gem install bundler
~ $ bundle exec jekyll serve -p 3005
```
This will run a local copy of the docs at http://0.0.0.0:3005/supplejack/
## Editing pages
Existing pages are under the '_posts' directory. All these files use [Markdown](http://daringfireball.net/projects/markdown/).
Once you have made and saved your changes, refresh your browser, the changes should be there.
If you are doing lots of changes or would like to review your changes, just run
```bash
git diff
```
## Creating new pages
To create a new page run the following commad in the root of the docs site.
```bash
ruby ./bin/jekyll-page "Page name" page-category
```
This script builds a new page with the correct time stamping and create a symlink in the pages directory.
### Template
Supplejack docs are built using [jekyll-docs-template](http://bruth.github.io/jekyll-docs-template)
http://bruth.github.io/jekyll-docs-template