|
1 | | -Insight Journal MyST Template |
2 | | -=============================== |
| 1 | +Insight Journal Publication Template |
| 2 | +==================================== |
3 | 3 |
|
4 | 4 | [](https://github.com/InsightSoftwareConsortium/InsightJournalTemplate/actions/workflows/build-myst.yml) |
5 | 5 |
|
6 | | -This repository contains a modern template for submitting Technical Reports to the |
7 | | -Insight Journal using MyST Markdown: |
| 6 | +This repository contains a modern template for open science publications for the |
| 7 | +[Insight Journal]: |
8 | 8 |
|
9 | 9 | https://insight-journal.org |
10 | 10 |
|
11 | | -## Overview |
| 11 | +## Features |
12 | 12 |
|
13 | | -This template has been transformed from LaTeX to **MyST Markdown**, providing: |
14 | | - |
15 | | -- 🚀 **Modern authoring** with MyST Markdown |
16 | | -- 📦 **Dependency management** with Pixi |
| 13 | +- 🚀 **Modern authoring** with [MyST Markdown] |
| 14 | +- 📦 **Dependency management** with [Pixi] |
17 | 15 | - 🔄 **Reproducible builds** and environments |
18 | | -- 📄 **Multiple export formats** (PDF, HTML, DOCX, MECA) |
19 | | -- 🧪 **Integrated source code** testing and validation |
| 16 | +- 📄 **Multiple export formats** (PDF, HTML, DOCX, [MECA]) |
| 17 | +- 🧪 **Integrated source code** testing and validation support |
20 | 18 | - 📚 **Rich scientific features** (equations, citations, cross-references) |
21 | 19 |
|
22 | 20 | ## Quick Start |
23 | 21 |
|
24 | | -See the complete documentation in [`doc/README.md`](doc/README.md). |
| 22 | +See the complete documentation in [`docs/README.md`](docs/README.md). |
25 | 23 |
|
26 | 24 | ### With Pixi (Recommended) |
27 | 25 |
|
28 | | -1. Install [Pixi](https://pixi.sh/latest/) |
| 26 | +1. Install [Pixi] |
29 | 27 | 2. Clone and build: |
30 | | - ```bash |
31 | | - git clone https://github.com/InsightSoftwareConsortium/InsightJournalTemplate.git |
32 | | - cd InsightJournalTemplate |
33 | | - pixi install |
34 | | - pixi run build-complete |
35 | | - ``` |
36 | | - |
37 | | -### Legacy LaTeX Template |
38 | | - |
39 | | -The original LaTeX template is still available in the `Document/` directory. |
40 | | - |
41 | | -**Overleaf Link**: https://www.overleaf.com/latex/templates/insight-journal/grjrhxkzzsvf |
42 | 28 |
|
| 29 | +```bash |
| 30 | +git clone https://github.com/InsightSoftwareConsortium/InsightJournalTemplate.git |
| 31 | +cd InsightJournalTemplate |
| 32 | +pixi install |
| 33 | +pixi run build-complete |
| 34 | +``` |
43 | 35 |
|
44 | 36 | License |
45 | 37 | ------- |
46 | 38 |
|
47 | 39 | All source code in this repository is distributed under the Apache 2.0 |
48 | | -License. Please see the LICENSE file for details. |
| 40 | +License. Please see the [LICENSE](./LICENSE) file for details. |
49 | 41 |
|
50 | 42 | All documents and works of art in this repository are distributed under the |
51 | | -Creative Commons by Attribution License 3.0. |
| 43 | +[Creative Commons by Attribution License 4.0]. |
| 44 | + |
| 45 | +[Insight Journal]: https://insight-journal.org |
| 46 | +[MyST Markdown]: https://mystmd.org |
| 47 | +[Pixi]: https://pixi.sh/latest/ |
| 48 | +[MECA]: https://www.niso.org/standards-committees/meca |
| 49 | +[Creative Commons by Attribution License 4.0]: https://creativecommons.org/licenses/by/4.0/ |
0 commit comments