|
7 | 7 |
|
8 | 8 | # nexus |
9 | 9 |
|
| 10 | +nexus is a threefold documentation resource for open research: native, external (via pointers, usually URLs), and hybrid. |
| 11 | +Hybrid documentation is commentary produced by working through an external resource such as a tutorial. This is intended |
| 12 | +to fill context gaps, note gotchas and so on: Make the path easier to follow. |
| 13 | + |
10 | 14 |
|
11 | 15 | This (gh-pages-branch) source file is [`index.md`](https://github.com/robfatland/nexus/blob/gh-pages/index.md)). |
12 | 16 |
|
13 | | -- [published: nexus](https://robfatland.github.io/nexus) and a corresponding [editable `index.md`](https://github.com/robfatland/nexus/blob/gh-pages/index.md) |
14 | | -- [published: lexicon](https://robfatland.github.io/nexus/lexicon) and a corresponding [editable `lexicon.md`](https://github.com/robfatland/nexus/blob/gh-pages/lexicon.md) |
| 17 | + |
| 18 | +- [published: nexus](https://robfatland.github.io/nexus) ~ [editable `index.md`](https://github.com/robfatland/nexus/blob/gh-pages/index.md) |
| 19 | +- [published: lexicon](https://robfatland.github.io/nexus/lexicon) ~ [editable `lexicon.md`](https://github.com/robfatland/nexus/blob/gh-pages/lexicon.md) |
15 | 20 |
|
16 | 21 |
|
17 | 22 | ## How is this site built and published? |
18 | 23 |
|
19 | 24 |
|
20 | | -This **nexus** repo uses a Jekyll template (the service is called *GitHub pages*) to publish the |
21 | | -content in a nice format. The content resides in the repo on a code branch called `gh-pages`. |
22 | | -Publication is triggered automatically after each *commit*. As a result there are three URLs: |
| 25 | +This **nexus** repo uses a [Jekyll](https://jekyllrb.com/) template (the free service is called *GitHub pages*) |
| 26 | +to generate a nicely formatted static website. The content resides in the repo on a code branch called `gh-pages`. |
| 27 | +Publication is triggered automatically after each *commit*. URLs: |
23 | 28 |
|
24 | 29 |
|
25 | | -- [The main branch of the github repo](https://github.com/robfatland/nexus/tree/main) |
26 | | -- [The gh-pages branch of the github repo](https://github.com/robfatland/nexus/tree/gh-pages) |
27 | | -- [The published documentation website](https://robfatland.github.io/nexus/) |
28 | | - - [A sub-folder example](https://robfatland.github.io/nexus/vscode) |
| 30 | +- [main branch of the nexus GitHub repo](https://github.com/robfatland/nexus/tree/main) |
| 31 | +- [gh-pages branch](https://github.com/robfatland/nexus/tree/gh-pages) |
| 32 | +- [The nexus static website](https://robfatland.github.io/nexus/) |
29 | 33 |
|
30 | 34 |
|
31 | 35 | Here is how to get one of these https://**organization**.github.io/**repo** websites started: |
|
0 commit comments