Skip to content

Commit 6caebf5

Browse files
authored
Update index.md
1 parent 19633da commit 6caebf5

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

index.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,29 @@
77

88
# nexus
99

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+
1014

1115
This (gh-pages-branch) source file is [`index.md`](https://github.com/robfatland/nexus/blob/gh-pages/index.md)).
1216

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)
1520

1621

1722
## How is this site built and published?
1823

1924

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:
2328

2429

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/)
2933

3034

3135
Here is how to get one of these https://**organization**.github.io/**repo** websites started:

0 commit comments

Comments
 (0)