Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build github.io with pandoc #316

Merged
merged 25 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
b1c5131
Prepare switch to pandoc
HeikoTheissen Apr 10, 2024
8d23c14
Rebuild Markdown
HeikoTheissen Apr 10, 2024
4be3113
oasis-tcs/odata-vocabularies as dependency
HeikoTheissen Apr 11, 2024
d803f99
Remove stale image link
HeikoTheissen Apr 11, 2024
f4c518f
Bump dependency
HeikoTheissen Apr 11, 2024
c3b7a8b
include pandoc-filter in package-lock.json
HeikoTheissen Apr 11, 2024
587f2f9
Reinsert broken link
HeikoTheissen Apr 11, 2024
8ee02b9
Link to GitHub
HeikoTheissen Apr 11, 2024
2450e31
No params in workflows
HeikoTheissen Apr 11, 2024
d67815e
Bump dependency
HeikoTheissen Apr 11, 2024
2132027
typographics
HeikoTheissen Apr 11, 2024
b43b5ce
Added express as dev dependency
ralfhandl Apr 11, 2024
4c66873
Revert "typographics"
HeikoTheissen Apr 11, 2024
157fc79
typographics
HeikoTheissen Apr 11, 2024
fdbcf4e
Merge branch 'tools/build-with-pandoc' of git@github.com:SAP/odata-vo…
HeikoTheissen Apr 11, 2024
8300213
auto-refreshed
HeikoTheissen Apr 11, 2024
7e58082
No more <
HeikoTheissen Apr 11, 2024
7a3930b
Merge branch 'tools/build-with-pandoc' of
HeikoTheissen Apr 11, 2024
ff02e76
auto-refreshed
HeikoTheissen Apr 11, 2024
f5163c7
Bring back _site/.gitignore
HeikoTheissen Apr 11, 2024
c3ab6b4
Merge branch 'tools/build-with-pandoc' of git@github.com:SAP/odata-vo…
HeikoTheissen Apr 11, 2024
c179f68
Use temporary commit
HeikoTheissen Apr 11, 2024
d0c1870
auto-refreshed
HeikoTheissen Apr 11, 2024
9a2ca64
npm run serve-pages
HeikoTheissen Apr 11, 2024
cf980f5
Bump dependency
HeikoTheissen Apr 11, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Build GitHub Pages using pandoc

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Setup pandoc
uses: nikeee/setup-pandoc@v1
with:
pandoc-version: 3.1.12.2
- name: Build with pandoc
run: |
npm ci
npm run pages
- name: Upload artifact
uses: actions/upload-pages-artifact@v3

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
4 changes: 4 additions & 0 deletions .github/workflows/nodejs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ jobs:
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- name: Setup pandoc
uses: nikeee/setup-pandoc@v1
with:
pandoc-version: 3.1.12.2
- name: npm install, build, and test
run: |
npm ci
Expand Down
33 changes: 0 additions & 33 deletions _layouts/default.html

This file was deleted.

2 changes: 2 additions & 0 deletions _site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*
!.gitignore
92 changes: 92 additions & 0 deletions assets/template.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="$lang$" xml:lang="$lang$"$if(dir)$ dir="$dir$"$endif$>
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
$for(author-meta)$
<meta name="author" content="$author-meta$" />
$endfor$
$if(date-meta)$
<meta name="dcterms.date" content="$date-meta$" />
$endif$
$if(keywords)$
<meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$" />
$endif$
$if(description-meta)$
<meta name="description" content="$description-meta$" />
$endif$
<title>$if(title-prefix)$$title-prefix$ – $endif$$pagetitle$</title>
<style>
$styles.html()$
</style>
$for(css)$
<link rel="stylesheet" href="$css$" />
$endfor$
$for(header-includes)$
$header-includes$
$endfor$
$if(math)$
$if(mathjax)$
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
$endif$
$math$
$endif$
</head>
<body>
$for(include-before)$
$include-before$
$endfor$
<div class="container-lg px-3 my-5 markdown-body">
$if(title)$
<header id="title-block-header">
<h1 class="title">$title$</h1>
$if(subtitle)$
<p class="subtitle">$subtitle$</p>
$endif$
$for(author)$
<p class="author">$author$</p>
$endfor$
$if(date)$
<p class="date">$date$</p>
$endif$
$if(abstract)$
<div class="abstract">
<div class="abstract-title">$abstract-title$</div>
$abstract$
</div>
$endif$
</header>
$endif$
$if(toc)$
<nav id="$idprefix$TOC" role="doc-toc">
$if(toc-title)$
<h2 id="$idprefix$toc-title">$toc-title$</h2>
$endif$
$table-of-contents$
</nav>
$endif$
$body$
</div>
<footer>
<div class="container">
<p>
© Copyright 2016&ndash;2024, SAP SE and odata-vocabularies Contributors.
<a href="https://www.sap.com/corporate/en/legal/impressum.html">Legal Disclosure</a>.
<a href="https://www.sap.com/corporate/en/legal/terms-of-use.html">Terms of Use</a>.
<a href="$github-repo$/blob/main/$github-path$">View On <strong>GitHub</strong></a>.
</p>
<p>
This site is hosted by <a href="https://pages.github.com/">GitHub Pages</a>.
Please see the <a href="https://docs.github.com/en/github/site-policy/github-privacy-statement">GitHub Privacy Statement</a> for any information how GitHub processes your personal data.
</p>
</div>
</footer>
$for(include-after)$
$include-after$
$endfor$
$for(include-script)$
$include-script$
$endfor$
</body>
</html>
Loading