Why make this website?​

I do not enjoy browsing the Emacs documentation within Emacs nor on the GNU website. The main things lacking for me are

1. An easy way to get an overview of all the topics (the sidebar)
2. Good search functionality

Why name it Emacs Docs?​

Mostly so it can be easily found when you ~google~ look it up with your search engine of choice, and because naming things is hard 🤷

What is that adorable little mascot called?​

Their name is Ellie!

Copyright?​

Should be good! The terms of the GFDL (GNU Free Documentation License) allow such modifications.

Can you include X?​

Maybe! I want to limit this website to documentation of major Emacs packages, not make an Emacs-wiki clone. If you have a suggestion let me know on Github!

The way these docs are generated work best if the authors produce on big HTML file such as the Elisp manual, otherwise modifications will have to be made.

There's something wrong!​

Whoops! Sorry! HTML does not lend itself to perfect conversion to Markdown, so some links could be messed up. I keep a list of "bad" links here to which you can add the incorrect link url and the correct one, meaning it should be fixed next build.

Do you have any other fantastic projects?​

Why yes! I maintain org-roam-ui, a way to interact with your org-roam Zettelkasten more visually.

Emacs Docs is dual-licensed under the GNU Free Documentation License and the GNU General Public License version 3 or later.

The text​

All text is licensed under the GNU Free Documentation License version 1.3, see the copyright notice below.

License statement​

Copyright (c) 2021 Thomas F.K. Jorna. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

See the license here

The verbatim copies of the included manuals retain their original license, see the copyright notices included in each section.

The code​

With CODE we mean all files included which are not in the docs or blog folder, or files which include uppercase LICENSE in the title (such as this file).

All code is licensed under the GNU General Public License version 3 or later as follows.

License statement​

Emacs Docs: GNU Emacs documentation for the 21st century.

Copyright (C) 2021 Thomas F. K. Jorna

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See the license here