Skip to content

Update docs extraction script to handle preset titles - #10

Merged
rlenferink merged 1 commit into
masterfrom
consistent-title
Jul 21, 2020
Merged

Update docs extraction script to handle preset titles#10
rlenferink merged 1 commit into
masterfrom
consistent-title

Conversation

@rlenferink

Copy link
Copy Markdown
Member

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:

[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'
[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
[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
[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: apache/celix#271

@rlenferink
rlenferink requested review from abroekhuis and pnoltes July 19, 2020 18:20
@netlify

netlify Bot commented Jul 19, 2020

Copy link
Copy Markdown

Deploy preview for celix-staging ready!

Built with commit 3891c3a

https://deploy-preview-10--celix-staging.netlify.app

@rlenferink
rlenferink merged commit 3d80515 into master Jul 21, 2020
@rlenferink
rlenferink deleted the consistent-title branch July 21, 2020 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants