Skip to content

SimplyPrint/docs-apidocs

 
 

Repository files navigation

Slate v3 POC

Build

Slate Logo

Proof-of-concept Slate v3 using eleventy as the static site generator.

screenshot

Features

Install

Requires an LTS version of Node.js

  • Clone the repository
  • npm i

or

  • Create your Node.js project (npm init)

  • Add @slatedocs/slate as a (dev)dependency (npm i [--save-dev] @slatedocs/slate)

  • npx slate init

Running

  • To build: npm run build
  • To debug: npm run debug
  • To serve: npm run serve and browse to http://localhost:4567

(If installed as a dependency, use npx slate [build|debug|serve])

TODO

  • Watch scss files
  • Do we need a .nojekyll file for GitHub pages deploys?
  • Option to use lunr server-side / across multiple files #1006
  • GitHub emoji shortcuts (as in Shins), yea or nay?
  • Specify additional CSS includes in header?

Additional plugin possibilities

About

SimplyPrint API docs

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages

  • SCSS 41.8%
  • Shell 17.6%
  • JavaScript 17.1%
  • Ruby 11.7%
  • HTML 6.4%
  • Python 4.7%
  • Dockerfile 0.7%