You only need a text editor with Markdown support and preview to start writing documentation. Simply fork the repo, clone your fork and start writing.
# Fork this repo and clone your fork
git clone git@github.com:YOUR_USERNAME/ractivejs.github.io.git ractive.js.org
cd ractive.js.org
# Start editing the docs!
If you want to run the full site locally, you will need a virtualenv setup. Install the following additional software and do the following commands. Installation of the additional software may vary by platform. Refer to their platform-specific documentation to know more.
# Create a virtualenv and activate it
virtualenv ractivejs.github.io
cd ractivejs.github.io
# Fork this repo and clone your fork
git clone git@github.com:YOUR_USERNAME/ractivejs.github.io.git src
cd src
# Start the virtualenv
source ../bin/activate
# on Windows start the virtualenv with
..\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Start the webserver
mkdocs serve
# When done developing, deactivate the virtualenv
deactivate
# Install broken-link checker
npm install -g broken-link-checker
# Run broken-link checker while mkdocs is running
blc -egorv http://localhost:8000
docs
directory.legacy
directory.path-to/my/hello-world.md
).mkdocs.yml
under pages
.Providing examples:
N4IgF...uEA
) and use it to place a RUN IT
button right above your code section.el: '#container'
, unnecessary parts of template, the new
keyword, ...) and place it in a code section under Examples header.Example of an example:
Actual working code:
Html:
<div id="output"></div>
Script:
ractive = new Ractive({
el: '#output',
template: `
<h2>Check the console</h2>
`,
data: {
foo: {
bar: 1,
baz: 2
}
}
})
console.log(ractive.get('foo')) // => {bar: 1, baz: 2}
Stripped version that is placed into the Examples section:
<div data-playground="N4IgFiBcoE5SAbAhgFwKYGcUgL4BoQN4YkBjFASwDc0ACAXloDs0B3WgJTMpoApgAOkwEoRaBJFoByAMQB7AK4oADkql4htLbXQBbZcnSSABpu3mAPGABMAPgDCYNKQDWOp7VJymGOQjQWAPQ2tmZaxhpM5gAmqEiSglHaIgBmcnIJYbQiIgBGSDCSAIx42UlaOSj5AF6S1lkiOFlNTDgAlEJCXj5+aAB0CHIA5rwk5NT9Q2govFJpclJtbbSBgQy2tMD5hbQltDV1OCAE2JAgFtHUtBTR9AIgiipK97ZBl1S2uEA"></div>
```js
ractive = Ractive({
data: {
foo: {
bar: 1,
baz: 2
}
}
})
console.log(ractive.get('foo')) // => {bar: 1, baz: 2}
```