Giter VIP home page Giter VIP logo

dds-manual's Introduction

How to contribute to the docs

Prerequisites

Steps

  • To clone the github reposity right click your desktop and select "Git Bash Here"

  • From there you can execute git clone https://github.com/davidsdesignserver/docs.git

  • Close the current git bash window and open the cloned folder. It should be named "docs"

  • Right click in this folder and open git bash again.

  • Execute python -m venv venv

  • Execute source venv/scripts/activate

  • Execute pip install mkdocs-material

  • Execute mkdocs serve

  • If everything went smoothly it should say its "Serving on" something like http://127.0.0.1:5800

  • This is a local hosted verson of the website you use to have a live preview of the site while editing.

  • You can now open the "docs" folder inside of VSCode

  • Once inside you should be able to navigate to the bottom left branch icon and create a new branch to start working in.

  • Commits to branches other than main will not regenerate the site

  • Do not push to main without permission

dds-manual's People

Contributors

ishalini avatar howlongismyname avatar neelmondkar avatar astro2231 avatar revision-0 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.