Smartcooly

Sleek, intuitive, and powerful front-end framework for faster and easier web development.
Explore Smartcooly docs »

Report bug · Request feature

Table of contents

• Running documentation locally
• Publish to github
• Copyright and license
• Denote

Running documentation locally

1. Run through the tooling setup to install Jekyll (the site builder) and other Ruby dependencies with bundle install.
2. Run npm install to install Node.js dependencies.
3. Run npm run dist to generate dist directory.
4. Run npm run test (or a specific NPM script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
5. From the root /Smartcooly directory, run npm run docs-serve in the command line.
6. Open http://localhost:9001 in your browser, and voilà.

caution: if run bundle install occurs error, use sudo bundle install instead.

Learn more about using Jekyll by reading its documentation.

Publish to github

1. Create and push to gh-pages.

git subtree push --prefix=dist origin gh-pages

2. Compile project, run npm run dist, then run npm run docs-compile.

3. Push sub directory _gh_pages to gh-pages branch.

Copyright and license

Code and documentation copyright @2018 by marstau and Code released under the MIT License. Docs released under Creative Commons.

Denote