https://github.com/michaelhatherly/publish.jl

A universal document authoring package for Julia.
https://github.com/michaelhatherly/publish.jl

commonmark documentation-tool julia latex markdown writing-tool

Last synced: 1 day ago
JSON representation

A universal document authoring package for Julia.

• Host: GitHub
• URL: https://github.com/michaelhatherly/publish.jl
• Owner: MichaelHatherly
• License: other
• Created: 2020-08-18T21:12:11.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-09-22T22:34:27.000Z (about 2 years ago)
• Last Synced: 2024-10-02T05:05:47.506Z (1 day ago)
• Topics: commonmark, documentation-tool, julia, latex, markdown, writing-tool
• Language: JavaScript
• Homepage:
• Size: 6.01 MB
• Stars: 97
• Watchers: 6
• Forks: 9
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Publish.jl

*A universal document authoring package for [Julia][julia].*









> **Disclaimer**

>

> Currently this package should be regarded as experimental --- a proving

> ground for new features for the Julia documentation ecosystem rather than

> a mature and proven piece of software. If you need a solution that will

> definitely work, look at [Documenter.jl][] instead.

[documenter.jl]: https://juliadocs.github.io/Documenter.jl/stable/

This is a package for [Julia][] that provides a general framework for writing

prose --- technical documentation is its focus, though it is general enough to

be applied to any kind of written document.

Some standout features:

  - built-in live server to view your changes in real-time,

  - uses a fully-compliant [commonmark][] parser, [CommonMark.jl][],

  - produces HTML and PDF files natively, no LaTeX dependencies to manage yourself,

  - publication-quality PDF generation uses [tectonic][] for self-contained, reproducible builds,

  - combine markdown files, [Jupyter][] notebooks, and Julia files for your content,

  - supports [themes](# "Custom Themes") to customise both HTML and PDF output,

  - and declarative configuration built on top of Julia's [Pkg.jl][] package manager.

`Publish` can scale from single pages all the way to large cross-referenced

multi-project documents.

To jump straight in and begin using `Publish` run the following in your Julia REPL:

```julia-repl

pkg> add Publish

julia> using Publish

julia> serve(Publish)

✓ LiveServer listening on http://localhost:8000/ ...

  (use CTRL+C to shut down)

```

The above will install `Publish`, import it, and then start up a local

web-server for `Publish`'s own documentation --- the content you're reading

right now. Open the link in your web browser and then continue on to the next

section, [Getting Started](docs/getting_started.md).

[commonmark]: https://commonmark.org/

[CommonMark.jl]: https://www.github.com/MichaelHatherly/CommonMark.jl

[Julia]: https://www.julialang.org

[Jupyter]: https://jupyter.org/

[tectonic]: https://tectonic-typesetting.github.io/en-US/

[pkg.jl]: https://julialang.github.io/Pkg.jl