celix-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [celix-site] rlenferink opened a new pull request #10: Update docs extraction script to handle preset titles
Date Sun, 19 Jul 2020 18:20:32 GMT

rlenferink opened a new pull request #10:
URL: https://github.com/apache/celix-site/pull/10


   This updates the docs extraction script to be able to handle preset properties (e.g. titles);
meaning after a release this script can be called with the released version and documentation
will be pre-processed automatically.
   
   Tested using:
   
   ```bash
   [root@centos8 test]# ./extract_celix_docs.sh 1.0.0
   'source/./test/bla.md' -> 'target/1.0.0/celix/./test/bla.md'
   'source/./bla2.md' -> 'target/1.0.0/celix/./bla2.md'
   'source/./bla.md' -> 'target/1.0.0/celix/./bla.md'
   ```
   
   ```bash
   [root@centos8 test]# cat source/bla2.md
   # Title
   Description
   [root@centos8 test]# cat target/1.0.0/celix/bla2.md
   ---
   title: bla2.md
   type: celix-doc
   version: 1.0.0
   ---
   
   # Title
   Description
   ```
   
   ```bash
   [root@centos8 test]# cat source/test/bla.md
   ---
   title: Bla die Bla / Test
   ---
   
   # Title
   Description
   [root@centos8 test]# cat target/1.0.0/celix/test/bla.md
   ---
   title: Bla die Bla / Test
   type: celix-doc
   version: 1.0.0
   ---
   
   # Title
   Description
   ```
   
   ```bash
   [root@centos8 test]# cat source/bla.md
   ---
   title: Bla die ba 2
   type: celix-alternative-doc
   ---
   
   # Title
   Description
   [root@centos8 test]# cat target/1.0.0/celix/bla.md
   ---
   title: Bla die ba 2
   type: celix-alternative-doc
   version: 1.0.0
   ---
   
   # Title
   Description
   ```
   
   Xref: https://github.com/apache/celix/pull/271


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



Mime
View raw message