smartkarma / frontend-guide

Smartkarma frontend guide

Home Page:https://smartkarma.github.io/frontend-guide/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

React Native has been moved to Jira Confluence: https://sk-team.atlassian.net/wiki/spaces/PRODUCTTEC/pages/8224784/Mobile+App

Beginner: How to contribute

Follow additional instructions in Structure

Just edit/add new .md files to the root in GitHub directly to master branch

Advanced: How to contribute

Follow additional instructions in Structure

For easy preview of changes and live-reload 🤘

  1. Clone repo
  2. Globally install Docsify: yarn global add docsify-cli
  3. Run from repo folder: docsify serve ./docs
  4. Change files and preview docs: http://localhost:3000

Structure

  • Add new pages to the root folder only. Add project prefix to the filename. eg: native-something.md
  • Each new page has to be added in: _sidebar.md
  • To split a page into multiple sections, use 2nd level header ## Heading

About