Skip to content

Commit 5dfc40e

Browse files
clsourceclsource
committed
modified readme
1 parent 15ae496 commit 5dfc40e

5 files changed

Lines changed: 92 additions & 96 deletions

File tree

‎CONTRIBUTORS.adoc‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
= Contributors
2+
3+
Example usage for docs creation.
4+
5+
== Commands
6+
7+
- `make install`: Builds the Dockerfile.
8+
- `make build`: Compiles Antora Docs.
9+
- `make sh`: Opens the Container.
10+
- `make server`: Starts a new server for the html version. (requires python3).
11+
12+
== Usage
13+
14+
. Change `CONTAINER_LABEL=local/antora:example-docs` (in Makefile) to an unique name for your docs.
15+
. Install the Container: `make install`.
16+
. (In another terminal) Open a localhost: `make server`.
17+
. Open Container: `make sh`.
18+
. Change settings in `antora-playbook.yml`
19+
. Add modules in `antora.yml`
20+
. Run Antora: `antora antora-playbook.yml --stacktrace`.
21+
. See results in `localhost:8000`
22+
23+
If something does not work or not render well remember that *antora* needs a git repository.
24+
25+
- `git init`: Creates a new git repo.
26+
- `git commit -am 'update docs'`: Creates a new commit, after this try to render the docs again.
27+
28+
[NOTE]
29+
====
30+
If you want to have `make` in Windows you can use https://git-scm.com/install/windows[bash from git]
31+
====
32+
33+
== How to add content
34+
35+
Inside `modules` you can add a new module that will contain pages, examples and images.
36+
37+
Example let's create a new *users* module.
38+
39+
[source, text]
40+
----
41+
modules/
42+
users/
43+
nav.adoc
44+
pages/
45+
users.adoc
46+
roles.adoc
47+
images/
48+
image1.png
49+
examples/
50+
example.py
51+
ROOT/
52+
...
53+
----
54+
55+
- pages: Will contain the adoc pages for the content.
56+
- images: Will contain images used inside the pages with `image::image1.png[]`.
57+
- examples: Will contain code examples and other resources for the content.
58+
59+
=== Contents
60+
61+
Inside `nav.adoc` you must put the pages.
62+
63+
.nav.adoc
64+
[source, asciidoc]
65+
----
66+
.Users
67+
* xref:users.adoc[]
68+
* xref:roles.adoc[]
69+
----
70+
71+
Inside `examples` you can store code.
72+
73+
.example.exs
74+
[source, elixir]
75+
----
76+
include::modules/ROOT/examples/example.exs[]
77+
----

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.PHONY: install build server sh antora.build
22
BUILD=docker
3-
CONTAINER_LABEL=local/antora:example-docs
3+
CONTAINER_LABEL=local/antora:elixir-ml
44

55
install i:
66
${BUILD} build -t ${CONTAINER_LABEL} .

‎README.adoc‎

Lines changed: 11 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,28 @@
11
:fn-ninjas: footnote:[https://ninjas.cl]
2+
:fn-elixircl: footnote:[https://elixircl.github.io]
23

3-
= Antora Docs Bootstrap
4+
= 🧿 Elixir Machine Learning & Large Language Models
45

5-
This is a simple configuration for creating documentation with https://docs.antora.org/[Antora Docs].
6+
El siguiente libro contiene los conocimientos necesarios
7+
para utilizar herramientas de Machine Learning (ML), Large Language Models (LLM),
8+
entre otros. Enfocado en el lenguaje de programación _Elixir_ y su ecosistema.
69

7-
It includes:
10+
== 📝 Licencia
811

9-
- Dockerfile
10-
- Kroki (Plant UML and others)
11-
- Search
12+
Creado con ❤️ por https://ninjas.cl[Camilo Castro]{fn-ninjas} y https://github.com/elixircl/elixir-ml/graphs/contributors[contribuidores]footnote:[https://github.com/elixircl/elixir-ml/graphs/contributors]. para https://elixircl.github.io[Elixir Chile]{fn-elixircl}.
1213

13-
== Commands
14-
15-
- `make install`: Builds the Dockerfile.
16-
- `make build`: Compiles Antora Docs.
17-
- `make sh`: Opens the Container.
18-
- `make server`: Starts a new server for the html version. (requires python3).
19-
20-
== Usage
21-
22-
. Change `CONTAINER_LABEL=local/antora:example-docs` (in Makefile) to an unique name for your docs.
23-
. Install the Container: `make install`.
24-
. (In another terminal) Open a localhost: `make server`.
25-
. Open Container: `make sh`.
26-
. Change settings in `antora-playbook.yml`
27-
. Add modules in `antora.yml`
28-
. Run Antora: `antora antora-playbook.yml --stacktrace`.
29-
. See results in `localhost:8000`
30-
31-
If something does not work or not render well remember that *antora* needs a git repository.
32-
33-
- `git init`: Creates a new git repo.
34-
- `git commit -am 'update docs'`: Creates a new commit, after this try to render the docs again.
35-
36-
[NOTE]
37-
====
38-
If you want to have `make` in Windows you can use https://git-scm.com/install/windows[bash from git]
39-
====
40-
41-
== How to add content
42-
43-
Inside `modules` you can add a new module that will contain pages, examples and images.
44-
45-
Example let's create a new *users* module.
46-
47-
[source, text]
48-
----
49-
modules/
50-
users/
51-
nav.adoc
52-
pages/
53-
users.adoc
54-
roles.adoc
55-
images/
56-
image1.png
57-
examples/
58-
example.py
59-
ROOT/
60-
...
61-
----
62-
63-
- pages: Will contain the adoc pages for the content.
64-
- images: Will contain images used inside the pages with `image::image1.png[]`.
65-
- examples: Will contain code examples and other resources for the content.
66-
67-
=== Contents
68-
69-
Inside `nav.adoc` you must put the pages.
70-
71-
.nav.adoc
72-
[source, asciidoc]
73-
----
74-
.Users
75-
* xref:users.adoc[]
76-
* xref:roles.adoc[]
77-
----
78-
79-
Inside `examples` you can store code.
80-
81-
.examples/example.py
82-
[source, asciidoc]
83-
----
84-
include::example$example.py[]
85-
----
86-
87-
== License
88-
89-
Created with ❤️ by https://ninjas.cl[Camilo Castro] and https://github.com/NinjasCL/antora-docs-bootstrap/graphs/contributors[contributors]footnote:[https://github.com/NinjasCL/antora-docs-bootstrap/graphs/contributors]. for https://ninjas.cl[Ninjas.cl]{fn-ninjas}.
90-
91-
This document is licensed with http://creativecommons.org/licenses/by-nc-sa/4.0/[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International]footnote:[http://creativecommons.org/licenses/by-nc-sa/4.0/]
14+
Este libro está bajo la http://creativecommons.org/licenses/by-nc-sa/4.0/[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International]footnote:[http://creativecommons.org/licenses/by-nc-sa/4.0/]
9215

9316
http://creativecommons.org/licenses/by-nc-sa/4.0/[image:https://raw.githubusercontent.com/NinjasCL/asciidoc-book-template/main/resources/images/by-nc-sa.svg[Licencia Creative Commons]]
9417

95-
Source code licensed with https://opensource.org/licenses/BSD-2-Clause[BSD-2]footnote:[https://opensource.org/licenses/BSD-2-Clause].
96-
97-
== 🤩 Credits
18+
Código fuente bajo https://opensource.org/licenses/BSD-2-Clause[BSD-2]footnote:[https://opensource.org/licenses/BSD-2-Clause].
9819

20+
== 🤩 Créditos
9921
++++
10022
<p>
10123
Made with <i class="fa fa-heart">&#9829;</i> by
10224
<a href="https://ninjas.cl">
10325
Ninjas.cl
10426
</a>.
10527
</p>
106-
++++
107-
108-
109-
See Also: https://github.com/NinjasCL/asciidoc-book-template/tree/main[Asciidoc Book Template]
28+
++++

‎antora-playbook.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site:
2-
title: Example Documentation
3-
url: https://ninjascl.github.io/antora-docs-bootstrap
2+
title: Elixir ML & LLM
3+
url: https://elixircl.github.io/elixir-ml
44
start_page: "ROOT::index.adoc"
55

66
content:

‎antora.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: ROOT
22
version: ~
3-
title: Example Documentation
3+
title: Elixir ML & LLM
44
nav:
55
- modules/ROOT/nav.adoc

0 commit comments

Comments
 (0)