Giter Site home page Giter Site logo

hg200 / docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from hoppscotch/docs

0.0 0.0 0.0 55.14 MB

📖 Hoppscotch documentation (work in progress) - https://docs.hoppscotch.io

Home Page: https://docs.hoppscotch.io

License: MIT License

Shell 3.25% JavaScript 46.84% Vue 49.91%

docs's Introduction

Banner

Docs

Hoppscotch

Documentation

Setup

Install dependencies:

npm run install

Development

npm run dev

Static Generation

This will create the dist/ directory for publishing to static hosting:

npm run generate

To preview the static generated app, run npm run start

Contributors Guide

We are looking for translators to help us with translations of Docs. docs.hoppscotch is built with nuxt-content. For detailed explanation on how things work, checkout nuxt/content and @nuxt/content theme docs.

Steps

  1. Follow the Setup Guide

  2. To add your language to the dropdown menu, go to nuxt.config.js, add code,iso,file and name of the language.

        {
            code: 'fr',
            iso: 'fr-FR',
            file: 'fr-FR.js',
            name: 'Français'
            }
  3. To add translated content, navigate to \content, add a folder with language code as the name and add .md files.

       content
       |
       |- en
       |  |- article.md
       |- fr
           |-article.md <----translated
  4. Make sure that the file names for translated content are the same as that of the english document.

  5. Add screenshots to \static\Resources\<your lang>\ or re-use screenshots of the english version.

docs's People

Contributors

amoldericksoans avatar liyasthomas avatar varghesejose2020 avatar rahuldimri avatar gc-shisir avatar andrewbastin avatar andypiper avatar anildash avatar anwarulislam avatar bkintanar avatar gep13 avatar jopijuco avatar krmh04 avatar rhullah avatar sukriti-sood avatar tkhadimullin avatar airdrummingfool avatar vivienbcr avatar wcrum avatar babyjohndev avatar ibromz 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.