Skip to content
A Jekyll version of the beautiful Docsy!
CSS HTML JavaScript Other
Branch: master
Clone or download
vsoch adding badge
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
Latest commit 5195b51 Aug 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci restore previous config Jul 26, 2019
_data
_docs adding stars and forks count Jul 27, 2019
_includes adding stars and forks count Jul 27, 2019
_layouts adding permalinks Jul 27, 2019
_posts start of site, lots more work to do Jul 26, 2019
assets adding preview image Aug 3, 2019
pages cleaning up main docs index Jul 27, 2019
.gitignore testing circle Jul 26, 2019
CHANGELOG.md adding site.url to config Aug 3, 2019
Gemfile start of site, lots more work to do Jul 26, 2019
LICENSE start of site, lots more work to do Jul 26, 2019
README.md adding badge Aug 4, 2019
VERSION adding site.url to config Aug 3, 2019
_config.yml adding site.url to config Aug 3, 2019

README.md

Docsy Jekyll Theme

CircleCI Jekyll Themes Shield

https://raw.githubusercontent.com/vsoch/docsy-jekyll/master/assets/img/docsy-jekyll.png

This is a starter template for a Docsy jekyll theme, based on the Beautiful Docsy that renders with Hugo. This version is intended for native deployment on GitHub pages. The original Apache License is included.

Changes

The site is intended for purely documentation, so while the front page banner is useful for business or similar, this author (@vsoch) preferred to have the main site page go directly to the Documentation view. Posts are still provided via a feed.

Usage

1. Get the code

You can clone the repository right to where you want to host the docs:

git clone https://github.com/vsoch/docsy-jekyll.git docs
cd docs

2. Customize

To edit configuration values, customize the _config.yml. To add pages, write them into the pages folder. You define urls based on the permalink attribute in your pages, and then add them to the navigation by adding to the content of _data/toc.myl. The top navigation is controlled by _data/navigation.yml

3. Options

Most of the configuration values in the _config.yml are self explanatory, and for more details, see the getting started page rendered on the site.

4. Serve

Depending on how you installed jekyll:

jekyll serve
# or
bundle exec jekyll serve
You can’t perform that action at this time.