Bedrock Github Pages documentation source files. A static site built using Metalsmith.
HTML CSS JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
build
layouts
src
.gitignore
README.md
_config.yml
build.js
package.json

README.md

Bedrock Documentation Site

These are the source files for Bedrock's documentation site. It is a static website built using Metalsmith, so I put it up here as an example of a static site that can be built using it.

Here's a screenshot of what the static site looks like:

Check out this blog post for more information on how to build static websites using NodeJS and Metalsmith.

Features

  • Writing using Github Flavored Markdown
  • Using Handlebars layout
  • Automatic table-of-contents and navigation based on headings
  • Syntax Highlighting
  • One-line deploy to Github Pages

Installation and Building

git clone git@github.com:tilomitra/bedrock-docs.git
npm install
node build.js

This will set up a browser-sync environment, where all your changes will automatically reload and rebuild the static site.

To deploy to Github Pages:

npm run deploy --prod

This will push everything in the build/ directory to the gh-pages branch of whatever your origin remote is.