Giter VIP home page Giter VIP logo

techpass-user-docs's Introduction

TechPass User Doc Repository

This is a documentation repository for TechPass, written for Documentation Portal, using docsify. You can find out what docsify or markdown extensions are supported here.

The repository is currently in active development and contents will change rapidly.

File Structure

All markdown files should live within the /docs folder. Each main section should be a separate markdown file by itself. If you have added a new main section, you should also update _sidebar.md so that it will show up when the webpage is rendered.

All non-markdown files (i.e. images and sample code files) should live within the assets subfolder.

Running Locally

Setting Up

  • Install docsify cli npm -g install docsify-cli
  • Download this repository via git clone
  • Run docsify serve .

Setting Up on zsh terminal

if you get zsh:1: command not found: docsify after npm install: make sure you add export PATH="$HOME/.npm-packages/bin:$PATH" to the 1st line in your ~/.zshrc. Then source ~/.zshrc to reload. Finally, test with docsify --version. You should see the following:

docsify-cli version: x.x.x

Syntax Highlighting

The repository has been pre-configured to pull in the default Developer Portal's styling for Documentations. (See index.html)

Web Hosting

By default, once you commit and push any changes into github, the contents will be updated automatically.

Contributing

Please fork the repository, make your changes and submit a Pull Request.

techpass-user-docs's People

Contributors

seng-siong avatar yilunyou avatar yang-lijia avatar jleechan avatar damienngor avatar weijunyu avatar denisecollard avatar brootware avatar jovanhyw avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.