Giter Club home page Giter Club logo

nodemanual.org's Introduction

Introduction

This is the source documentation for Node Manual. It consists of:

  • Source files for the Node.js Reference Guide, Node.js tutorials, and Node.js Javascript Reference Guide (located in src/)
  • Resources such as CSS, Javascript, and images, for the final output (located at resources/)
  • Templates for the design (also located at resources/)

For API documentation, we use Panino; for the reference material, we use Panda-Docs.

It's worth noting that there is a git commit hook running on the NodeManual server. Any pushes or merges into the master branch of this repo automatically rebuilds all versions of the documentation on the website.

Running a Build

To run the build, open your command prompt and type:

node build.js [optional_version_number]

This launches a build of the latest documentation set, which is determind by whatever the last folder in src/ is. These converted HTML files are placed into out/. Also, a symlink called latest/ is created, that points to the latest output files. If you pass in optional_version_number, then only that doc set is built, and no symlink is created.

Contributing

We'll very gladly take any pull requests for new documentation! This source material is intended to be open and sharable to all.

Copyright

Major content providers include:

License

Creative Commons License
Node Manual is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.

nodemanual.org's People

Watchers

 avatar  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.