Skip to content

Commit bf5ffb5

Browse files
phcerdanphcerdan
authored
Merge pull request #7 from thewtex/myst
MyST Markdown Refactor
2 parents 63462df + 0e57a40 commit bf5ffb5

40 files changed

+797
-8440
lines changed

‎.github/workflows/build-myst.yml‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
name: MyST Documents, Source Code
2+
3+
on:
4+
push:
5+
branches: [ main, myst ]
6+
pull_request:
7+
branches: [ main, myst ]
8+
workflow_dispatch:
9+
10+
jobs:
11+
build-myst:
12+
runs-on: ubuntu-24.04
13+
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v5
17+
18+
- name: Setup Pixi
19+
uses: prefix-dev/[email protected]
20+
with:
21+
pixi-version: latest
22+
23+
- name: Install dependencies
24+
run: pixi install
25+
26+
- name: Build HTML
27+
run: pixi run build-html
28+
29+
- name: Build PDF
30+
run: pixi run build-pdf
31+
32+
- name: Build MECA
33+
run: pixi run build-meca
34+
35+
- name: Upload build artifacts
36+
uses: actions/upload-artifact@v4
37+
with:
38+
name: myst-outputs
39+
path: |
40+
_build/
41+
exports/
42+
retention-days: 30
43+
44+
build-source:
45+
runs-on: ubuntu-24.04
46+
47+
steps:
48+
- name: Checkout repository
49+
uses: actions/checkout@v5
50+
51+
- name: Setup Pixi
52+
uses: prefix-dev/[email protected]
53+
with:
54+
pixi-version: latest
55+
56+
- name: Install dependencies
57+
run: pixi install
58+
59+
- name: Build source code
60+
run: pixi run build-src
61+
62+
- name: Run tests
63+
run: pixi run test-src
64+
65+
- name: Upload test results
66+
uses: actions/upload-artifact@v4
67+
if: always()
68+
with:
69+
name: test-results
70+
path: |
71+
build/Testing/
72+
retention-days: 30
73+
74+
deploy:
75+
runs-on: ubuntu-latest
76+
needs: [build-myst, build-source]
77+
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/myst'
78+
79+
steps:
80+
- name: Checkout repository
81+
uses: actions/checkout@v5
82+
83+
- name: Setup Pixi
84+
uses: prefix-dev/[email protected]
85+
with:
86+
pixi-version: latest
87+
88+
- name: Install dependencies
89+
run: pixi install
90+
91+
- name: Build for deployment
92+
run: pixi run build-html
93+
94+
- name: Deploy to GitHub Pages
95+
uses: peaceiris/actions-gh-pages@v3
96+
if: github.ref == 'refs/heads/main'
97+
with:
98+
github_token: ${{ secrets.GITHUB_TOKEN }}
99+
publish_dir: ./_build/html

‎.github/workflows/build-test-latex.yml‎

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,31 @@
1-
name: Build LaTeX document
1+
name: Build LaTeX Document
22

33
on: [push,pull_request]
44

55
jobs:
6-
build_latex:
7-
runs-on: ubuntu-latest
6+
build-latex:
7+
runs-on: ubuntu-24.04
88
steps:
99
- name: Set up Git repository
10-
uses: actions/checkout@v2
10+
uses: actions/checkout@v5
11+
1112
- name: Set up LaTeX packages
1213
run: |
1314
sudo apt-get update
1415
sudo apt-get install texlive texlive-publishers texlive-science latexmk
15-
- name: Compile LaTeX document
16-
run: |
17-
cd Document/LaTeX
18-
make
19-
- name: Check pdf files
20-
run: |
21-
set -e
22-
file Document/LaTeX/ArticleExample.pdf | grep -q ' PDF '
16+
17+
- name: Setup Pixi
18+
uses: prefix-dev/[email protected]
19+
with:
20+
pixi-version: latest
21+
22+
- name: Build PDF
23+
run: pixi run build-arxiv
24+
25+
- name: Upload build artifacts
26+
uses: actions/upload-artifact@v4
27+
with:
28+
name: arxiv-pdf-outputs
29+
path: |
30+
exports/
31+
retention-days: 30

‎.gitignore‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# LaTeX build artifacts
12
*.aux
23
*.bbl
34
*.blg
@@ -9,3 +10,49 @@
910
*.ps
1011
*.toc
1112
_minted-*/
13+
14+
# MyST Markdown build outputs
15+
_build/
16+
site/
17+
.myst/
18+
*.epub
19+
*.meca
20+
21+
# Pixi environment and cache
22+
.pixi/
23+
pixi.lock
24+
__pycache__/
25+
*.pyc
26+
27+
# IDE and editor files
28+
.vscode/
29+
.idea/
30+
*.swp
31+
*.swo
32+
*~
33+
34+
# OS files
35+
.DS_Store
36+
Thumbs.db
37+
38+
# Build directories
39+
build/
40+
dist/
41+
CMakeCache.txt
42+
CMakeFiles/
43+
cmake_install.cmake
44+
Makefile
45+
46+
# Node.js (if using MyST plugins)
47+
node_modules/
48+
npm-debug.log*
49+
yarn-debug.log*
50+
yarn-error.log*
51+
52+
# Python virtual environments
53+
venv/
54+
env/
55+
.env
56+
57+
exports/
58+
data/img1.png.base.png

‎CITATION.cff‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
cff-version: 1.2.0
2+
message: Please cite the following works when using this project.
3+
title: Insight Journal MyST Template
4+
authors:
5+
- family-names: Galilei
6+
given-names: Galileo
7+
affiliation: Pisa University
8+
address: Tower Drive, Pisa, Italy
9+
orcid: 0000-0000-0000-0001
10+
email: [email protected]
11+
- family-names: Bruno
12+
given-names: Giordano
13+
affiliation: Rome University
14+
address: Inquisition Street, Rome, Italy
15+
orcid: 0000-0000-0000-0002
16+
email: [email protected]
17+
- family-names: Leeuwenhoek
18+
given-names: Anthony
19+
affiliation: Netherlands Pragmatic University
20+
address: Port Street, Netherlands
21+
orcid: 0000-0000-0000-0003
22+
email: [email protected]
23+
contact:
24+
- family-names: Galilei
25+
given-names: Galileo
26+
affiliation: Pisa University
27+
address: Tower Drive, Pisa, Italy
28+
orcid: 0000-0000-0000-0001
29+
email: [email protected]
30+
license: CC-BY-4.0
31+
license-url: https://creativecommons.org/licenses/by/4.0/
32+
repository: https://github.com/InsightSoftwareConsortium/InsightJournalTemplate

0 commit comments

Comments
 (0)