You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
+[`content`](content) contains the manuscript source, which includes markdown files as well as inputs for citations and references.
54
-
See [`USAGE.md`](USAGE.md) for more information.
55
-
+[`output`](output) contains the outputs (generated files) from Manubot including the resulting manuscripts.
56
-
You should not edit these files manually, because they will get overwritten.
57
-
+[`webpage`](webpage) is a directory meant to be rendered as a static webpage for viewing the HTML manuscript.
58
-
+[`build`](build) contains commands and tools for building the manuscript.
59
-
+[`ci`](ci) contains files necessary for deployment via continuous integration.
60
-
61
-
### Local execution
62
-
63
-
The easiest way to run Manubot is to use [continuous integration](#continuous-integration) to rebuild the manuscript when the content changes.
64
-
If you want to build a Manubot manuscript locally, install the [conda](https://conda.io) environment as described in [`build`](build).
65
-
Then, you can build the manuscript on POSIX systems by running the following commands from this root directory.
66
-
67
-
```sh
68
-
# Activate the manubot conda environment (assumes conda version >= 4.4)
69
-
conda activate manubot
70
-
71
-
# Build the manuscript, saving outputs to the output directory
72
-
bash build/build.sh
73
-
74
-
# At this point, the HTML & PDF outputs will have been created. The remaining
75
-
# commands are for serving the webpage to view the HTML manuscript locally.
76
-
# This is required to view local images in the HTML output.
77
-
78
-
# Configure the webpage directory
79
-
manubot webpage
80
-
81
-
# You can now open the manuscript webpage/index.html in a web browser.
82
-
# Alternatively, open a local webserver at http://localhost:8000/ with the
83
-
# following commands.
84
-
cd webpage
85
-
python -m http.server
86
-
```
87
-
88
-
Sometimes it's helpful to monitor the content directory and automatically rebuild the manuscript when a change is detected.
89
-
The following command, while running, will trigger both the `build.sh` script and `manubot webpage` command upon content changes:
90
-
91
-
```sh
92
-
bash build/autobuild.sh
93
-
```
94
-
95
-
### Continuous Integration
96
-
97
-
Whenever a pull request is opened, CI (continuous integration) will test whether the changes break the build process to generate a formatted manuscript.
98
-
The build process aims to detect common errors, such as invalid citations.
99
-
If your pull request build fails, see the CI logs for the cause of failure and revise your pull request accordingly.
100
-
101
-
When a commit to the `main` branch occurs (for example, when a pull request is merged), CI builds the manuscript and writes the results to the [`gh-pages`](https://github.com/manubot/rootstock/tree/gh-pages) and [`output`](https://github.com/manubot/rootstock/tree/output) branches.
102
-
The `gh-pages` branch uses [GitHub Pages](https://pages.github.com/) to host the following URLs:
103
-
104
-
+**HTML manuscript** at https://manubot.github.io/rootstock/
105
-
+**PDF manuscript** at https://manubot.github.io/rootstock/manuscript.pdf
106
-
107
-
For continuous integration configuration details, see [`.github/workflows/manubot.yaml`](.github/workflows/manubot.yaml) if using GitHub Actions or [`.travis.yml`](.travis.yml) if using Travis CI.
108
-
>>>>>>> 9a448fe6edb477fb98065d5b83d206b1ca489cee
109
47
110
48
## License
111
49
@@ -123,5 +61,4 @@ The EOSC-Synergy project has received funding from the European Union’s Horizo
0 commit comments