https://github.com/tefkah/emacs-docs

The documentation website Emacs deserves
https://github.com/tefkah/emacs-docs

auctex documentation docusaurus elisp emacs magit org-mode

Last synced: about 1 month ago
JSON representation

The documentation website Emacs deserves

• Host: GitHub
• URL: https://github.com/tefkah/emacs-docs
• Owner: tefkah
• License: other
• Created: 2021-11-28T00:07:13.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-05T18:35:33.000Z (almost 3 years ago)
• Last Synced: 2024-05-02T02:52:46.023Z (8 months ago)
• Topics: auctex, documentation, docusaurus, elisp, emacs, magit, org-mode
• Language: JavaScript
• Homepage: https://emacsdocs.org
• Size: 3.88 MB
• Stars: 270
• Watchers: 5
• Forks: 10
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Emacs Docs

> The modern documentation website Emacs deserves.

![Emacs Docs Mascot](https://emacsdocs.org/img/Banner.png)

## Why

I didn't particularly enjoy either browsing the manual online or in Emacs, and wished there was a modern equivalent. Luckily, there is now!

## Included manuals

- Emacs Manual [source](https://www.gnu.org/software/emacs/manual/emacs.html)

- Emacs Lisp Manual [source](https://www.gnu.org/software/emacs/manual/elisp.html)

- Org Mode Manual [source](https://www.gnu.org/software/emacs/manual/org.html)

- AUCTeX Manual [source](https://www.gnu.org/software/auctex/manual/auctex.index.html)

- Magit Manual [source](https://magit.vc/manual/magit/)

### How to include other manuals

Only documentation for Emacs core and Emacs packages will be included, which must satisfy the following requirements:

1. Be licensed under a free documentation license such as the GNU Free Documentation License 1.3 or Creative Commons Attribution 4.0 license or other free software licenses such as the GPLv3 or MIT.

2. Are available in either Markdown or big-single-page HTML format.

3. Are authoritative references on parts of GNU Emacs or packages interacting with GNU Emacs.

## FAQs

Please see [the FAQs](https://emacsdocs.org/blog/faq)

## Misc

The scripts used to convert the HTML manuals to Markdown can be found [here](https://github.com/ThomasFKJorna/emacs-docs-converter). Please note that it's extremely jank and will be substantially revised in the future, contributors are welcome, but you've been warned!

## Comments and Feedback

If you have any ideas or feddback about the project or the design of the website, please open a disccusion! I'd be more than happy to talk to discuss this further.