Code Monkey home page Code Monkey logo

docs's Introduction

Docs

Setup

  1. Install Node.js

    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
    source ~/.bashrc
  2. Install the latest LTS version of npm

    nvm install v18.12.1
  3. Install yarn

     npm install --global yarn
  4. Install dependencies

    yarn

Run

yarn start

Tools

  1. To resize images, use imagemagick on Linux

    sudo apt install imagemagick-6.q16

    Resize all images in a folder

    convert "*.jpg[800x]" -set filename:base "%[basename]" "%[filename:base].jpg"

Formatting

  1. Maintain a correct order of the headings. Use H1 for page titles, H2 for sections and H3 for subsections. Don't jump from H1 to H3 without an H2 in between.

  2. Resize the images to ideally to a width of 800px maintaining the aspect ratio.

  3. Use Code (`Code`) blocks for text that makes direct reference to a component in the software. E.g., Done button.

  4. Use Bold (**Bold**) characters to highlight important words or phrases.

  5. Use Italics (*Italics*) for names of 3rd party products and items.

  6. Avoid having one single long line of text and add a newline after 120 characters.

docs's People

Contributors

divyanshupundir avatar ajaykarthikr avatar dependabot[bot] avatar akshata-01 avatar

Stargazers

 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.