Fork this repository on your account. Then, to build the Github Pages, Github needs a push. To do it, you can simply change a file with the Github Interface or use the console after cloning the forked repository: git push origin master
.
Finally, go on http://[your-github-username].github.io/[your-github-repository] and start editing documents in Markdown or HTML in a simple editor.
You can edit in real time your documents with your Github collaborators by updating config.js
with the option firebase_url
set to your Firebase URL. To get one, you just have to signup on Firebase.
{
...
firebase_url: 'xxxx-xxxx-xxxx.firebaseIO.com'
}
That's it! You can start editing in real time with your collaborators.
To install contentify over a Github private repository, you have to clone this repository with --bare
option and push it with --mirror
option on your private repository:
git clone --bare https://github.com/thyb/contentify.git
cd content.git
git push --mirror https://github.com/YOUR-LOGIN/YOUR-REPO.git
Then, to prevent the Github Pages site from being displayed by non collaborator users, go to https://github.com/LOGIN/REPO, and update config.js
to put the option private
set to true
.
var config = {
...
private: true
};
(sudo) npm install -g harp grunt-cli
git clone [email protected]/thyb/contentify.git
cd contentify/
npm install
You have to update the config.js
file to configure the runtime if you're hosting contentify locally.
e.g.
var config = {
username: 'thyb'
repository: 'contentify'
};
grunt