Git Product home page Git Product logo

docs's Introduction

For writers

Contributing

Setting up a local editing environment

  1. Start a local documentation server:

    make server
    

    If everything is fine, you should see output similar to:

    [I 201112 11:16:39 server:335] Serving on http://0.0.0.0:8000
    INFO    -  Serving on http://0.0.0.0:8000
    [I 201112 11:16:39 handlers:62] Start watching changes
    INFO    -  Start watching changes
    [I 201112 11:16:39 handlers:64] Start detecting changes
    INFO    -  Start detecting changes
    
  2. Open the browser at http://127.0.0.1:8000

Place your text editor side-by-side with the browser window if you want to have preview of your edits - the browser will keep refreshing every time you update documents.

Useful links:

Quick fixes directly from web

For quick edits/suggestions, edit links ("edit this page" at the top right corner) and create text suggestions directly from web. See GitHub documentation if you're unfamiliar with the workflow.

Linter

Required tools:

  • Docker

To run the markdown linter which also fixes small issues automatically:

make lint

docs's People

Contributors

v1dm45 avatar varnastadeus avatar alstum avatar viktorasm avatar saumas avatar ernestas2k avatar mjur-cast avatar anjmao avatar augustinass avatar zilvinasu avatar gocentas avatar karolisl avatar r0kas avatar mindaugascast avatar arouyan avatar jmazionis avatar andrejatcastai avatar castaitim avatar kiriloman avatar aldor007 avatar castaiphil avatar dariuspie avatar matas-cast 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.