Status - Access a Better Web, Anywhere
There is an
edit button on each page, which will take you directly to the document you need to edit on the
develop branch. Please make sure that any changes you make are against
develop. The idea is that we can merge recklessly to
develop, then anyone see if the changes look OK on
master is protected and only ever gets changed when merging develop (
git merge develop --ff). This method makes for easy maintenance AND allows a larger 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.
Adding a New Page
If you want to add a page to specific section, rather than just edit an existing page, you'll need to make sure your new page appears on the sidebar and is accessible to everyone.
- Add your page to
source/_data/sidebars.ymladd the appropriate text to the appropriate place.
themes/navy/languages/en.ymledit the sidebars section to make sure that your new text in
sidebars.ymlis rendered correctly.
Make sure you have node.js installed first.
- Open Terminal and navigate to the project root directory,
- We share common elements across our sites using submodules, so you'll need to get those too:
git submodule update --init --recursive cd themes/navy/layout/partial/shared-partials git checkout master git pull cd ../../../../../
- In another terminal, run
- This prevents the need for any global installs, and will allow you to have live reloading for any changes you are making.
- If you would like add new styles, you can find all the
themes/navy/source/scss- add your own there and keep things modular, clean and performing well.
- If you would like to add some JS for animations of images, or other potential bounties, the place to do that is
- Changing the header, footer, mobile nav, or scripts (in
after_footer) can be done in
- Each new subdirectory gets it's own route, so if you want to add a new section like
status.im/contribute, then just create a new directory in
source, name it what you want the route to be called, and add an
index.mdfile to it.
If you want it to have a unique layout, set it up something like this:
--- layout: extensions title: Status Extensions id: index ---
and then create the appropriate
extensions.swig layout file in
.swig files are exactly like html - so just write html in there and don't stress.
Unfortunately, adding subdirectories within subdirectories like
status.im/security/guides doesn't really work right now if you want to have a sidebar too, because it routes you to the wrong place. This could be the subject of a bounty.
For more information see our article on the Search Cluster.