Description: The static documentation site for the Capital Framework. Includes examples, code snippets, getting started and contribution instructions, etc.
Technology stack:
- Ruby - For installing Jekyll.
- Jekyll - Static site server.
- Node - For managing front-end dependencies.
Screenshot:
This site is powered by Jekyll a Ruby based static site generator. For front-end tooling and asset management we use Node and Gulp. Before running the site locally you will need these dependencies. We use homebrew on Mac OSX to manage installation of software. To install the project dependencies using homebrew enter the following:
$ brew install ruby
$ brew install node
$ gem install jekyll
$ npm install --global gulp-cliTo install the site's dependencies, navigate to the project directory and run:
$ bundle install
$ npm installTo launch the site, enter:
$ npm startThis will start the Jekyll server and the Gulp watch task. BrowserSync should launch a new browser window displaying the site at http://localhost:3000.
If you'd prefer to see the site without BrowserSync's live reload, you can access it at http://localhost:4000.
Deny/Allow connections. If you encounter the following message:
Do you want the application “node” to accept incoming network connections?
Hit Deny to close the dialog box.
If you encounter issues with the Capital Framework components shown in the documentation site, please post an issue in the Capital Framework issue tracker.
Example
A live demo can be viewed here.
For local installation, the local live is at http://localhost:4000/capital-framework/ (see installation instructions).
We welcome contributions to the Capital Framework or the documentation site itself. If interested, please read through our contributing page on the demo site.