GithubHelp home page GithubHelp logo

danielvandh / documenter.jl Goto Github PK

View Code? Open in Web Editor NEW

This project forked from juliadocs/documenter.jl

0.0 0.0 0.0 55.53 MB

A documentation generator for Julia.

Home Page: https://documenter.juliadocs.org

License: MIT License

JavaScript 3.64% Julia 90.44% CSS 0.04% TeX 0.64% Makefile 0.08% SCSS 5.17%

documenter.jl's Introduction

Documenter

A documentation generator for Julia.

Documentation Build Status
PkgEval

Installation

The package can be installed with the Julia package manager. From the Julia REPL, type ] to enter the Pkg REPL mode and run:

pkg> add Documenter

Or, equivalently, via the Pkg API:

julia> import Pkg; Pkg.add("Documenter")

Documentation

  • STABLE — documentation of the most recently tagged version.
  • DEVEL — documentation of the in-development version.

Project Status

The package is tested against, and being developed for, Julia 1.6 and above on Linux, macOS, and Windows.

Questions and Contributions

Usage questions can be posted on the Julia Discourse forum under the documenter tag, in the #documentation channel of the Julia Slack and/or in the JuliaDocs Gitter chat room.

Contributions are very welcome, as are feature requests and suggestions. Please open an issue if you encounter any problems. The contributing page has a few guidelines that should be followed when opening pull requests and contributing code.

Related packages

There are several packages that extend Documenter in different ways. The JuliaDocs organization maintains:

Other third-party packages that can be combined with Documenter include:

Finally, there are also a few other packages in the Julia ecosystem that are similar to Documenter, but fill a slightly different niche:

documenter.jl's People

Contributors

mortenpi avatar michaelhatherly avatar fredrikekre avatar odow avatar kristofferc avatar visr avatar pfitzseb avatar inkydragon avatar dependabot[bot] avatar bicycle1885 avatar ericphanson avatar timholy avatar ararslan avatar tribut avatar ianbutterworth avatar viralbshah avatar tkf avatar cormullion avatar zlatanvasovic avatar navidcy avatar hetarth02 avatar dilumaluthge avatar christopher-dg avatar iamed2 avatar knuesel avatar tkoolen avatar hyrodium avatar kimikage avatar rikhuijzer avatar tlnagy 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.