Git Product home page Git Product logo

customdocumentationapp's Introduction

Documentation Template Customization Guide ๐Ÿ“–

Hello there! ๐ŸŒŸ If you're looking to customize this beautiful documentation template with electric blue accents, a white main body, and a touch of 3D vibe, you've landed in the right place. Let's dive into how you can make this template yours!

How to Create Your Documentation ๐Ÿš€

  1. Clone the Repository or Download the Files:

    • Use git to clone the repository:
      git clone https://github.com/Leumas-Tech/CustomDocumentationApp
    • Alternatively, you can download the files directly from GitHub.
  2. Navigate to the script.js file: This is where you'll find the information1 array which stores all the documentation data.

  3. Modify the information1 Array: Update this array with your documentation details. Below, we'll break down each section of the JSON data for clarity.

Understanding the JSON Data Structure ๐Ÿง 

Here's what each part of the information1 data structure represents:

  • title: The main title of your documentation entry.

    • Example:
      "Doc1"
      
  • content: The main content of your documentation. You can add your detailed descriptions here.

    • Example:
      "Lorem ipsum doc1 content. Here's some **bold** markdown."
      
  • sources: An array of links related to your documentation. They will be rendered as clickable links.

    • Example:
      [
          "https://www.example.com/source1",
          "https://www.example.com/source2"
      ]
  • code: A block of code that you want to display. Enclosed in backticks to maintain formatting.

    • Example:
      function helloWorld() {
          console.log('Hello, world!');
      }
  • example: Contains a description and usage of your code or function.

    • description: A brief overview of the example.
    • usage: Demonstrates how to use your code.
    • Example:
      {
          "description": "This is an example of how to use the helloWorld function.",
          "usage": "helloWorld();  // outputs: Hello, world!"
      }
  • additionalNotes: If you have any other notes or tidbits you'd like to add, this is the place!

    • Example:
      "This is a place for any other notes or details you might want to include."
      
  • apiCall: If your documentation references an API, you can specify the endpoint here.

    • Example:
      "/stripe/authentications/users/v1"
      
  • type: Specifies the type of your documentation. It should be one of the following: "function", "api call", or "other".

    • Example:
      "function"
      

Add as many objects (or "docs") to the information1 array as you need!

And... That's a Wrap! ๐ŸŽ‰

Customizing this template should be a breeze now. If you face any issues or have any suggestions, feel free to raise an issue or send a pull request. Happy documenting!

customdocumentationapp's People

Contributors

leumas-tech avatar

Stargazers

AbubekerJ avatar

Watchers

 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.