Skip to main content

How to Add Docs

To be able to add docs to this site you will need access to this repo.

Getting Started​

Clone the repo​

  • using SSH
git clone git@project.samarth.ac.in:project/internal-docs.git
cd internal-docs
  • using HTTPS
git clone https://project.samarth.ac.in/project/internal-docs.git
cd internal-docs
caution

Be sure to checkout a new branch after cloning.

Folder Structure​

docs/
  └ menu-1/
    └ doc-1.md
    └ doc-2.md
  └ menu-2/
    └ doc-3.md
  ...
  └ menu-x/
    └ doc-x.md
static/
  └ img/
    └ menu-1/
      └ doc-1/
        └ img-1.png
    └ menu-2/
      └ doc-3/
        └ img-3.jpg

Adding a Page​

  1. To add a page, first create a .md inside docs/<menu-item>/<doc-title>.md.

    info

    Filename should be all lowercase and contain only hypens.

  2. Next, add a title starting with #.

  3. More content can be added to the page according to need.

Adding Images to Pages​

  1. To add images to your page place them inside the static/img/<menu-item>/<doc-title> folder.
  2. The path on the image in the document should be /img/<menu-item>/<doc-title>/<img>.
tip

Here is the markdown syntax to add images.

Publishing new Docs/changes​

New docs/changes must be submitted through merge requests or by clicking the Edit this page button at the bottom of each page.