Skip to content
This repository was archived by the owner on Oct 20, 2022. It is now read-only.

Commit ecc20ba

Browse files
doc: move the md2pdf files into the specific directory
- move the md2pdf files into the specific directory doc/md2pdf - add a README.md to explain the command to generate the pdf
1 parent 32b8f79 commit ecc20ba

5 files changed

Lines changed: 36 additions & 20 deletions

File tree

doc/md2pdf/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
How to generate a PDF document from a set of Markdown files with Docker ?
2+
3+
Follows the guide: [Fiware markdown to PDF](https://github.com/FiwareULPGC/fiware-markdown-to-pdf#quick-start-guide-with-docker)
4+
5+
## User Guide
6+
7+
git clone https://github.com/Orange-OpenSource/fiware-cepheus.git
8+
cd fiware-cepheus
9+
docker run -v=/Users/{UserName}/fiware-cepheus:/md2pdf fiwareulpgc/markdown-to-pdf -i /md2pdf/doc/md2pdf/md2pdf.yml -o /md2pdf/user-guide.pdf
10+
11+
## Admin Guide
12+
13+
git clone https://github.com/Orange-OpenSource/fiware-cepheus.git
14+
cd fiware-cepheus
15+
docker run -v=/Users/{UserName}/fiware-cepheus:/md2pdf fiwareulpgc/markdown-to-pdf -i /md2pdf/doc/md2pdf/md2pdf_admin.yml -o /md2pdf/admin-guide.pdf
16+

doc/md2pdf/md2pdf.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
files_order:
2+
- '../index.md'
3+
- '../cep/index.md'
4+
- '../cep/configuration.md'
5+
- '../cep/mapping.md'
6+
- '../cep/types.md'
7+
- '../cep/geospatial.md'
8+
- '../broker/index.md'
9+
- '../examples/1_RoomsAndFloors/index.md'
10+
- '../examples/2_CloseShutters/index.md'
11+
- '../examples/3_CepAndBroker/index.md'
12+
- '../examples/4_CepAndBrokerAndOrion/index.md'
13+
- '../examples/5_TemperatureThreshold/index.md'
14+
- '../examples/6_QueryAndCommand/index.md'
15+
- '../examples/7_Metadata/index.md'
16+
- '../examples/8_DateAndGeoPoint/index.md'
17+
- '../examples/9_Geofencing/index.md'

doc/md2pdf/md2pdf_admin.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
files_order:
2+
- '../admin/cep.md'
3+
- '../admin/broker.md'

md2pdf.yml

Lines changed: 0 additions & 17 deletions
This file was deleted.

md2pdf_admin.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)