Skip to content

Commit 5c2d010

Browse files
committed
add antora doc + workflow to deploy site
1 parent 3dcba60 commit 5c2d010

File tree

10 files changed

+2297
-1
lines changed

10 files changed

+2297
-1
lines changed

.github/workflows/main.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: Build and Deploy
4+
5+
# Controls when the action will run. Triggers the workflow on push or pull request
6+
# events but only for the master branch
7+
on:
8+
push:
9+
branches: [ master ]
10+
11+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
12+
jobs:
13+
# This workflow contains a single job called "build"
14+
build:
15+
# The type of runner that the job will run on
16+
runs-on: ubuntu-latest
17+
18+
# Steps represent a sequence of tasks that will be executed as part of the job
19+
steps:
20+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
21+
- uses: actions/checkout@v2.3.1
22+
- name: Install
23+
run: npm install
24+
working-directory: docs
25+
- name: Build
26+
run: npm run build
27+
working-directory: docs
28+
- name: Deploy
29+
uses: JamesIves/github-pages-deploy-action@3.5.9
30+
with:
31+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
32+
BRANCH: gh-pages # The branch the action should deploy to.
33+
FOLDER: build/site # The folder the action should deploy.
34+
working-directory: docs

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
/node_modules/
1+
/**/node_modules/
2+
/**/build/
23
/dist/
34
/bin/

README.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,10 @@
22

33
Remote include processor extension for asciidoctor
44

5+
----
6+
.code here
7+
[source,cpp]
8+
----
9+
include::https://raw.githubusercontent.com/feelpp/feelpp/develop/feelpp/quickstart/qs_laplacian.cpp[tag=env]
10+
----
11+
----

docs/antora.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
name: adoc-rip
2+
title: Asciidoctor Remote Include Processor
3+
version: latest
4+
nav:
5+
- modules/ROOT/nav.adoc
6+

docs/modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* xref::index.adoc[Asciidoctor Remote Include Processor]

docs/modules/ROOT/pages/index.adoc

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
= Asciidoctor Remote Include Processor Extension
2+
:stem: latexmath
3+
:uri-asciidoctorjs: https://github.com/asciidoctor/asciidoctor.js
4+
:uri-antora: https://docs.antora.org
5+
:antora: {uri-antora}[Antora]
6+
7+
An extension for {uri-asciidoctorjs}[Asciidoctor.js] that allows to include remote files in {antora}.
8+
9+
This is useful in {antora} which does not enable this asciidoctor feature, see discussion https://gitlab.com/antora/antora/-/issues/246[here].
10+
11+
== Install
12+
13+
Install the dependencies:
14+
15+
$ npm install asciidoctor.js asciidoctor-remote-include-processor
16+
17+
== Usage
18+
19+
=== Register as an Asciidoctor extension in the Antora playbook of your website
20+
21+
[source,yaml]
22+
----
23+
asciidoc:
24+
extensions:
25+
- "@feelpp/asciidoctor-remote-include-extension"
26+
----
27+
28+
=== Include a remote file
29+
30+
In an Antora adoc page, include a remote file
31+
32+
```adoc
33+
[source,cpp]
34+
----
35+
include::https://raw.githubusercontent.com/feelpp/asciidoctor-remote-include-processor/master/test/helloworld.cpp[]
36+
----
37+
```
38+
which gives:
39+
40+
[source,cpp]
41+
----
42+
include::https://raw.githubusercontent.com/feelpp/asciidoctor-remote-include-processor/master/test/helloworld.cpp[]
43+
----

0 commit comments

Comments
 (0)