Browse Source

enhance pandoc documentation generation

pass metadata and configuration with yaml file instead to put it into makefile and markdown file
This permit pretty mardown rendering into gitea GUI
master
Antoine 1 year ago
parent
commit
9bf38eca5a
3 changed files with 41 additions and 20 deletions
  1. +2
    -7
      Makefile
  2. +38
    -0
      pandocConfig.yaml
  3. +1
    -13
      readme.md

+ 2
- 7
Makefile View File

@@ -73,10 +73,5 @@ cleanD:
@rm -f data/*.key

doc:
@pandoc -s -f markdown+emoji -t html \
--shift-heading-level-by=2 \
--wrap=preserve \
--toc \
--toc-depth=2 \
--highlight-style=tango \
-o readme.html readme.md
@pandoc --defaults=pandocConfig.yaml


+ 38
- 0
pandocConfig.yaml View File

@@ -0,0 +1,38 @@
from: markdown+emoji
to: html5
output-file: readme.html
standalone: true
self-contained: false

# leave blank for input from stdin, use [] for no input:
input-files:
- readme.md

metadata:
title: "cryptomain.ex"
subtitle: "aes crypt / decrypt"
author: Antoine Roux <antoinroux@hotmail.fr>
date: 2020-04-27T02:17:42+02:00
abstract: "allow to crypt and decrypt file with aes algorithm"
description: |
this repository contain aes c++ program
this program allow to crypt and decrypt file
lang: en-GB

# ERROR, WARNING, or INFO
verbosity: INFO

# auto, preserve, or none
wrap: preserve
columns: 78
dpi: 72

table-of-contents: true
toc-depth: 2
shift-heading-level-by: 2
# lf, crlf, or native
eol: lf
ascii: true
highlight-style: tango
preserve-tabs: true
fail-if-warnings: true

+ 1
- 13
readme.md View File

@@ -1,16 +1,4 @@
---
author: Antoine Roux <antoinroux@hotmail.fr>
date: 2020-04-27T02:17:42+02:00
title: "cryptomain.ex"
subtitle: "aes crypt / decrypt"
abstract: "allow to crypt and decrypt file with aes algorithm"
description: |
this repository contain aes c++ program
this program allow to crypt and decrypt file
lang: en-GB
---

# this repository contains 3 mains :
# this repository contains 3 Main :

- crypto.ex use for test ( take a file, crypt and decrypt this file in one step )
products a crypted and decrypted file.


Loading…
Cancel
Save