https://github.com/deatrich/doc-with-pandoc-markdown

These are setup files and instructions needed for easily writing how-to guides with generated HTML, DOCX and PDF output.
https://github.com/deatrich/doc-with-pandoc-markdown

docx-generation html-generation markdown pandoc pdf-generation syntax-highlighting

Last synced: 10 days ago
JSON representation

These are setup files and instructions needed for easily writing how-to guides with generated HTML, DOCX and PDF output.

• Host: GitHub
• URL: https://github.com/deatrich/doc-with-pandoc-markdown
• Owner: deatrich
• License: cc0-1.0
• Created: 2023-07-31T21:20:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-09T16:10:12.000Z (about 1 year ago)
• Last Synced: 2023-09-09T17:26:10.507Z (about 1 year ago)
• Topics: docx-generation, html-generation, markdown, pandoc, pdf-generation, syntax-highlighting
• Language: Shell
• Homepage: https://deatrich.github.io/doc-with-pandoc-markdown/
• Size: 508 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Getting Started With Pandoc Markdown

While writing a guide about creating a [Linux Home Server][home-server] using

Pandoc Markdown I spent some time understanding issues and finding solutions.

For future markdown-based guides I want to reuse the setup files I created.

Thus I created this repository with all the setup files needed to easily 

begin writing guides, and to generate HTML, DOCX and PDF output files.

This guide was necessarily written using the Markdown markup language.  As the

flavour of Markdown used is the Pandoc flavour, then some features in

the document (like definition lists) may not render correctly in the

Github flavour.  Nevertheless, you can still 

[browse Markdown files in GitHub][mygithub.com].

Recent Pandoc-generated HTML, DOCX and PDF files are available

on my github.io site at:

  [https://deatrich.github.io/doc-with-pandoc-markdown/][mygithub.io]

This is a work in progress:

## Preliminary task list for main document

- [x] Copy and modify initial support files from *linux-home-server* project

- [x] Complete an 'overview' chapter 

- [x] Document the initial client software installation

- [x] Document support tools installation and configuration

- [x] Describe all support files

- [x] Moved *console* fenced code and editor setup and issues to \

 https://github.com/deatrich/console-syntax

- [x] Add additional topics like spell-checking

- [x] Write a chapter on using Pandoc with Markdown examples

- [x] Add this project to https://deatrich.github.io/

- [ ] Add *odt* output to the project

- [x] Add some scripts to create lists of commands, etc^[egs]

- [ ] Add some scripts to create lists of external links found in a document

[home-server]: https://github.com/deatrich/linux-home-server/

[mygithub.com]: https://github.com/deatrich/doc-with-pandoc-markdown/

[mygithub.io]: https://deatrich.github.io/doc-with-pandoc-markdown/

[^egs]: Example: use awk to count number of console segments and the list of commands, list of sudo commands, etc.