Repo for the Status Incubate website
Go to file
Andy Tudhope 7668ba65c4
Slight style change
2018-11-29 15:41:30 +02:00
scaffolds Initial skeleton 2018-10-04 22:26:45 +02:00
scripts Changes edit helper 2018-10-04 23:00:46 +02:00
source update root index title 2018-11-08 15:33:56 +06:30
themes/navy Slight style change 2018-11-29 15:41:30 +02:00
.eslintignore Initial skeleton 2018-10-04 22:26:45 +02:00
.eslintrc Initial skeleton 2018-10-04 22:26:45 +02:00
.gitignore Initial skeleton 2018-10-04 22:26:45 +02:00
.gitmodules Use shared partials (#11) 2018-11-28 10:44:40 +02:00
Jenkinsfile Updates Jenkinsfile 2018-11-28 10:58:50 +02:00
LICENSE Initial commit 2018-10-04 21:43:22 +02:00
README.md edit readme to use gulp 2018-11-17 11:45:42 +01:00
_config.dev.yml Changes for config 2018-10-22 18:25:07 +02:00
_config.prod.yml Changes for config 2018-10-22 18:25:07 +02:00
gulpfile.js change style and add gulp 2018-11-17 11:34:52 +01:00
package.json Use shared partials (#11) 2018-11-28 10:44:40 +02:00

README.md

Status Incubate

This repo hosts the code for both incubate.status.im on the master branch (which builds and serves through gh-pages), and dev-incubate.status.im on the develop branch.

There is an edit button on each page, which will take you directly to the document you need to edit on the develop branch. We can then allow a large group of people to push directly to develop and show their changes on the staging site when asking for review, which should smooth out and speed up the process considerably for everyone. master is obviously protected, and will only have changes merged in from develop once accepted.

Adding a New Page

If you want to add a page, rather than just edit, you'll need to make sure it appears on the sidebar and is accessible to everyone.

  1. Add your page to source/docs/<your_file_here>.md
  2. In source/_data/sidebars.yml add the appropriate text to the appropriate place.
  3. In themes/navy/languages/en.yml edit the sidebars section to make sure that your new text in sidebars.yml is rendered correctly.

Testing locally

Make sure you have node.js installed first.

  1. Open Terminal and navigate to the project root directory,
  2. Run npm install,
  3. Run ./node_modules/.bin/gulp build,
  4. In another terminal, run ./node_modules/.bin/hexo serve,
  5. This prevents the need for any global installs, and will allow you to have live reloading for any changes you are making.