Code Monkey home page Code Monkey logo

india-compliance-docs's Introduction

Welcome to the India Compliance App documentation! It includes tutorials, guides, and reference material for using the app.


Folder Structure

The India Compliance App repository has the following folder structure:

pages
│
├── .vitepress
│   └── config.js
│
├── blog
│   ├── authors
│   │   └── *.md
│   └── posts
│       └── *.md
│
└── docs
    └── topics
        |── *.md
        └── assets
            └── *.png
  • The pages folder contains the source code for the documentation site.
  • The docs folder contains the Markdown files for the documentation topics.
  • The assets folder within docs folder contains images or gif used for documentation.
  • The blog folder contains the Markdown files for blog posts.
  • The authors folder within blog contains Markdown files for author information.

Adding Documentation

To add documentation, create a new Markdown (.md) file in the appropriate directory for the topic:

pages/docs/topics/*.md

Then, add the file to the sidebar configuration in .vitepress/config.js using the Vitepress sidebar syntax. For example:

module.exports = {
  themeConfig: {
    sidebar: [
      {
        text: 'Topics',
        children: [
          '/docs/topics/introduction.md',
          '/docs/topics/getting-started.md',
          // Add new topics here
        ],
      },
    ],
  },
};

For more help see the Vitepress documentation.

Creating Blog Posts

To create a blog post, create a new Markdown file in the appropriate directory:

pages/blog/posts/*.md

Include blog information at the beginning of the file using the following format:

---
date: 2023-03-31
title: Blog Title
category: Tutorial
author: Author Name
description: Short Description of blog.
tags:
- Tag 1
- Tag 2
---

Start your blog here

The post's date, title, category, author, and description should be replaced with the appropriate values. You can also include tags to help organize and find the post.

Creating Author for Blog Posts

To create a author post, create a new Markdown file in the appropriate directory:

pages/blog/authors/*.md

Include author information at the beginning of the file using the following format:

---
author: {
  name: Author Name,
  avatar: https://example.com/avatar.png,
}
---

<AuthorDetail>
  
  ## Author Name
  
  Description of author and their expertise.
  
  [Github Link](https://github.com/example)
  
</AuthorDetail>

License

The India Compliance Documentation is licensed under the GNU General Public License v3.0.

india-compliance-docs's People

Contributors

vorasmit avatar ljain112 avatar daizymodi avatar divyam-mistry avatar abdeali099 avatar humenth avatar sagarvora avatar dependabot[bot] avatar

Stargazers

Darius avatar MohsinAli avatar  avatar

Watchers

MohsinAli avatar  avatar  avatar

india-compliance-docs's Issues

Misc fixes

  • update docs for sandbox mode
  • should be Setting Up, not Setting-Up

image

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.