Write, share, and publish documents with HedgeDoc

Scripting HedgeDoc

Besides managing users, you can also manage HedgeDoc notes using the command line or shell scripts. You can use hedgedoc-cli [12] to publish or save an existing note as a PDF file, to create new notes from existing local files, or to quickly import all the pads in an Etherpad account into HedgeDoc [13]. For instance, these two commands:

#> hedgedoc import /path/to/markdown/file.md abcdef
#> hedgedoc publish abcdef
exampleid

create a note that would be editable at https://HEDGEDOC_URL/abcdef and readable at https://HEDGEDOC_URL/s/exampleid.

Conclusion

If you ask me, Markdown is so easy, powerful, and flexible that it is a shame more people do not already use it as their preferred text formatting language. HedgeDoc makes Markdown even easier to use, and possibly also to teach to others, so give it a try!

Infos

  1. Markdown: http://www.markdownguide.org
  2. HedgeDoc: https://hedgedoc.org/
  3. HackMD: https://hackmd.io
  4. "Drawing Diagrams with PlantUML" by Marco Fioretti, Linux Magazine, issue 235, June 2020, https://www.linux-magazine.com/Issues/2020/235/PlantUML-Diagrams
  5. Diagrams examples: https://bramp.github.io/js-sequence-diagrams/
  6. MathJax: https://www.mathjax.org/
  7. Slideshow demo: https://demo.hedgedoc.org/p/slide-example
  8. HedgeDoc Cloudron app: https://docs.cloudron.io/apps/hedgedoc/
  9. HedgeDoc Docker images: https://quay.io/repository/hedgedoc/hedgedoc
  10. HedgeDoc Docker configuration: https://docs.hedgedoc.org/setup/docker/
  11. HedgeDoc general configuration: https://docs.hedgedoc.org/configuration/
  12. hedgedoc-cli: https://github.com/hedgedoc/cli
  13. How to import Etherpad pads into HedgeDoc:https://docs.hedgedoc.org/guides/migrate-etherpad/

The Author

Marco Fioretti (http://mfioretti.com) is a freelance author, trainer, and researcher based in Rome, Italy. He has been working with free/open source software since 1995 and on open digital standards since 2005. Marco also is a Board Member of the Free Knowledge Institute (http://freeknowledge.eu) and blogs about digital rights at https://stop.zona-m.net.

Buy this article as PDF

Express-Checkout as PDF
Price $2.95
(incl. VAT)

Buy Linux Magazine

SINGLE ISSUES
 
SUBSCRIPTIONS
 
TABLET & SMARTPHONE APPS
Get it on Google Play

US / Canada

Get it on Google Play

UK / Australia

Related content

comments powered by Disqus