Giter VIP home page Giter VIP logo

Comments (7)

nikhil25803 avatar nikhil25803 commented on September 26, 2024

Note - I have already set up the MkDocs.
You can use the following command to run and test the documentation files.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

from scrape-up.

adishgarg avatar adishgarg commented on September 26, 2024

Can i work on this issue under GSSoc'24? @nikhil25803

from scrape-up.

nikhil25803 avatar nikhil25803 commented on September 26, 2024

Go ahead @adishgarg

from scrape-up.

Daksh-khandelwal-1495 avatar Daksh-khandelwal-1495 commented on September 26, 2024

Would love to work on this issue when available !
Looking forward to it .

from scrape-up.

nikhil25803 avatar nikhil25803 commented on September 26, 2024

Hey @Daksh-khandelwal-1495, you can coordinate with @adishgarg and can work on other feature related to MkDocs.

Make sure to raise different PRs

from scrape-up.

adishgarg avatar adishgarg commented on September 26, 2024

@nikhil25803 do we want to replicate the Fast API doc completely or just use it as a reference because they employ a lot of external css and js

from scrape-up.

nikhil25803 avatar nikhil25803 commented on September 26, 2024

For reference only @adishgarg

from scrape-up.

Related Issues (20)

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.