> ## Content Index
> Fetch the complete content index at: https://www.process-one.net/llms.txt
> Use this file to discover other available public pages before exploring further.

# ejabberd Docs now using MkDocs
- URL: https://www.process-one.net/blog/ejabberd-docs-now-using-mkdocs/
- Published: 2024-04-24T09:58:00.000Z
- Updated: 2024-09-16T09:58:40.000Z
- Description: The ejabberd Docs website did just get a major rework: new content management system, reorganized navigation, improved markdown, and several improvements!
- Author: ProcessOne

## Brief documentation timeline

ejabberd started in November 2002 (see a timeline in the [ejabberd turns 20](https://www.process-one.net/blog/ejabberd-turns-20/) blog post). And the first documentation was published in January 2003, using LaTeX, see [Ejabberd Installation and Operation Guide](https://web.archive.org/web/20030409163941/http://ejabberd.jabberstudio.org/guide.html). That was one single file, hosted in the ejabberd CVS source code repository, and was available as a single HTML file and a PDF.

As the project grew and got more content, in 2015 the documentation was [converted from LaTeX to Markdown](https://www.process-one.net/blog/ejabberd-new-documentation-site-a-community-effort/), moved from ejabberd repository to a dedicated [docs.ejabberd.im](https://github.com/processone/docs.ejabberd.im?ref=process-one.net) git repository, and published using a Go HTTP server in `docs.ejabberd.im`, see an [archived ejabberd Docs site](https://web.archive.org/web/20240327173114/https://docs.ejabberd.im/).

## New ejabberd Docs site

Now the ejabberd documentation has moved to MkDocs+Material, and this brings several changes and improvements:

#### Site and Web Server:

- Replaced Go site with [MkDocs](https://www.mkdocs.org/?ref=process-one.net)
- [Material](https://squidfunk.github.io/mkdocs-material/?ref=process-one.net) theme for great features and visual appeal, including light/dark color schemes
- Still written in Markdown, but now using several MkDocs, Material and [Python-Markdown](https://python-markdown.github.io/extensions/?ref=process-one.net) extensions
- The online site is built by GitHub Actions and hosted in Pages, with smaller  
automatic deployment time
- Offline reading: the `ejabberd Docs` site can be downloaded as a PDF or zipped HTML, see the links in [home page](https://docs.ejabberd.im/?ref=process-one.net)

#### Navigation

- Major navigation reorganization, keeping URLs intact so old links still work (only Install got some relevant URL changes)
- [Install](https://docs.ejabberd.im/admin/install/?ref=process-one.net) section is split into several sections: Containers, Binaries, Compile, …
- Reorganized the [Archive](https://docs.ejabberd.im/archive/?ref=process-one.net) section, and now it includes the corresponding Upgrade notes
- Several markdown files from the ejabberd and docker-ejabberd repositories are now incorporated here

#### Content

- Many markdown visual improvements, specially in code snippets
- Options and commands that were modified in the last release will show a mark, see for example [API Reference](https://docs.ejabberd.im/developer/ejabberd-api/admin-api/?ref=process-one.net)
- Version annotations are shown after the corresponding title, see for example [sql\_flags](https://docs.ejabberd.im/admin/configuration/toplevel/?ref=process-one.net#sql%5Fflags)
- Modules can have version annotations, see for example [mod\_matrix\_gw](https://docs.ejabberd.im/admin/configuration/modules/?ref=process-one.net#mod%5Fmatrix%5Fgw)
- Links to modules, options and API now use the real name with `_` character instead of `-` (compare old [#auth-opts](https://web.archive.org/web/20231220132058/https://docs.ejabberd.im/admin/configuration/toplevel/#auth-opts) with [#auth\_opts](https://docs.ejabberd.im/admin/configuration/toplevel/?ref=process-one.net#auth%5Fopts)). The old links are still supported, no broken links.
- [Listen Modules](https://docs.ejabberd.im/admin/configuration/listen/?ref=process-one.net) section is now better organized
- New experimental [ejabberd Developer Livebook](https://docs.ejabberd.im/livebooks/ejabberd-developer-livebook/?ref=process-one.net)

So, please check the revamped [ejabberd Docs](https://docs.ejabberd.im/?ref=process-one.net) site, and head to [docs.ejabberd.im git repository](https://github.com/processone/docs.ejabberd.im?ref=process-one.net) to report problems and propose improvements.