https://github.com/restify/restify.github.io
Template for the restify website
https://github.com/restify/restify.github.io
Last synced: 3 months ago
JSON representation
Template for the restify website
- Host: GitHub
- URL: https://github.com/restify/restify.github.io
- Owner: restify
- License: mit
- Created: 2017-06-27T23:09:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-04T16:07:35.000Z (over 2 years ago)
- Last Synced: 2025-03-23T00:07:05.078Z (3 months ago)
- Language: CSS
- Homepage: https://restify.github.io
- Size: 2.47 MB
- Stars: 1
- Watchers: 3
- Forks: 15
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Restify Documentation
## Updating the docs
To pull in the latest documentation for the project, simply:
```bash
git clone --recursive [email protected]:restify/restify.github.io
cd restify.github.io
git submodule update --remote && git add _docs && git commit -m 'bump' && git push origin master
```
And the docs will automatically rebuild themselves using [GitHub Pages](https://pages.github.com/)
## Adding doc pages
To add a doc to the website, include the appropriate header:
```text
---
title: [Page Title]
permalink: /docs/[page-id]/
---
```
Then add the page to the navbar by adding the `page-id` to the appropriate section in `_data/docs.yml`:
For example:
```yml
...
- title: API
docs:
- server-api
- [page-id]
...
```
## Running locally
You need Ruby and gem before starting, then:
```bash
# install jekyll and bundler
gem install jekyll bundler
# clone the project
git clone https://github.com/aksakalli/jekyll-doc-theme.git
cd jekyll-doc-theme
# run jekyll with dependencies
bundle exec jekyll serve
```
## Design
We used the amazing [jekyll-doc-theme by aksakalli](https://aksakalli.github.io/jekyll-doc-theme/) as a jumping off point for our website!