TigerGraph-DevLabs / tg-ecosys-docs

Developer Portal

This site was created using MkDocs and is editable with using markdown. To learn about MkDocs, Markdown, and Material Theme please checkout resources below.

Developer Portal URL: https://tigergraph-oss.github.io/tg-ecosys-docs/

Intro to

MarkDown

Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).

Learn More: Markdown

MkDocs

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Learn More: MkDocs

MkDocs Material Theme

Material for MkDocs is a theme for MkDocs, a static site generator geared towards (technical) project documentation. If you're familiar with Python, you can install Material for MkDocs with pip, the Python package manager.

Learn More: Material

Getting Started

prerequirments

• python installed
• pip package installed
• mkdocs installed
• material-theme installed

Run Developer Portal Local

Python pip

Installing pip If you're using a recent version of Python, the Python package manager, pip, is most likely installed by default. However, you may need to upgrade pip to the lasted version:

pip install --upgrade pip

If you need to install pip for the first time, download get-pip.py. Then run the following command to install it:

python get-pip.py

MkDocs

Installing MkDocs Install the mkdocs package using pip:

pip install mkdocs

You should now have the mkdocs command installed on your system. Run mkdocs --version to check that everything worked okay.

$ mkdocs --version
mkdocs, version 0.15.3

Material Theme

** with pip**

Material for MkDocs can be installed with pip:

pip install mkdocs-material

Contributing

It's recommended that your fork this repository make modification and then submit a pull request back to the main repository.

Contribution Steps:

1. Make a fork of the repo you’ve chosen for your contributions.

2. From the fork, click Clone or download to create a copy on your computer. Optional: Add the base repository as a remote "upstream," which is helpful if you want to pull down new changes from the base repository into your fork.

3. Create a pull request from the branch on your fork into the master branch of the base repository. (Make sure to commit often and add as many details as possible to the pull request)

Reference Document

For help just ask any of the the developers in the TigerGraph Community Chat or TigerGraph Community Forum