File tree 4 files changed +50
-10
lines changed
4 files changed +50
-10
lines changed Original file line number Diff line number Diff line change 2
2
# npx antora --fetch antora-playbook.yml
3
3
site :
4
4
title : MrDocs
5
- url : https://cppalliance.github.io/mrdox /
6
- start_page : mrdox ::index.adoc
5
+ url : https://cppalliance.github.io/mrdocs /
6
+ start_page : mrdocs ::index.adoc
7
7
robots : allow
8
8
keys :
9
- repo_url : ' https://github.com/cppalliance/mrdox '
9
+ repo_url : ' https://github.com/cppalliance/mrdocs '
10
10
11
11
content :
12
12
branches : [ master, develop ]
13
13
tags : [ v* ]
14
- edit_url : ' https://github.com/cppalliance/mrdox /edit/{refname}/{path}'
14
+ edit_url : ' https://github.com/cppalliance/mrdocs /edit/{refname}/{path}'
15
15
sources :
16
- - url : https://github.com/cppalliance/mrdox .git
16
+ - url : https://github.com/cppalliance/mrdocs .git
17
17
start_path : docs
18
- edit_url : ' https://github.com/cppalliance/mrdox /edit/{refname}/{path}'
18
+ edit_url : ' https://github.com/cppalliance/mrdocs /edit/{refname}/{path}'
19
19
20
20
ui :
21
21
bundle :
Original file line number Diff line number Diff line change
1
+ #
2
+ # Licensed under the Apache License v2.0 with LLVM Exceptions.
3
+ # See https://llvm.org/LICENSE.txt for license information.
4
+ # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
5
+ #
6
+ # Copyright (c) 2023 Alan de Freitas ([email protected] )
7
+ #
8
+ # Official repository: https://github.com/cppalliance/mrdocs
9
+ #
10
+
11
+ # This script is used to build the documentation using Antora
12
+ # with the local playbook local-antora-playbook.yml
13
+
14
+ if [ $# -eq 0 ]
15
+ then
16
+ echo " No playbook supplied, using default playbook"
17
+ PLAYBOOK=" antora-playbook.yml"
18
+ else
19
+ PLAYBOOK=$1
20
+ fi
21
+
22
+ echo " Building documentation with Antora..."
23
+ echo " Installing npm dependencies..."
24
+ npm install
25
+
26
+ echo " Building docs in custom dir..."
27
+ npx antora --clean --fetch " $PLAYBOOK "
28
+ echo " Done"
Original file line number Diff line number Diff line change
1
+ #
2
+ # Licensed under the Apache License v2.0 with LLVM Exceptions.
3
+ # See https://llvm.org/LICENSE.txt for license information.
4
+ # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
5
+ #
6
+ # Copyright (c) 2023 Alan de Freitas ([email protected] )
7
+ #
8
+ # Official repository: https://github.com/cppalliance/mrdocs
9
+ #
10
+
11
+ echo " Building local documentation with Antora..."
12
+ ./build_docs.sh local-antora-playbook.yml
Original file line number Diff line number Diff line change 2
2
# npx antora --fetch local-antora-playbook.yml
3
3
site :
4
4
title : MrDocs
5
- url : https://cppalliance.github.io/mrdox /
6
- start_page : mrdox ::index.adoc
5
+ url : https://cppalliance.github.io/mrdocs /
6
+ start_page : mrdocs ::index.adoc
7
7
robots : allow
8
8
keys :
9
- repo_url : ' https://github.com/cppalliance/mrdox '
9
+ repo_url : ' https://github.com/cppalliance/mrdocs '
10
10
11
11
content :
12
12
sources :
13
13
- url : ..
14
14
start_path : docs
15
- edit_url : ' https://github.com/cppalliance/mrdox /edit/{refname}/{path}'
15
+ edit_url : ' https://github.com/cppalliance/mrdocs /edit/{refname}/{path}'
16
16
17
17
ui :
18
18
bundle :
You can’t perform that action at this time.
0 commit comments