Skip to content
Snippets Groups Projects
Commit 06ecaf0e authored by David Akim's avatar David Akim
Browse files

Update 10 files

- /docs/images/cyted1.png
- /docs/images/upload.png
- /docs/sesion01/milab.md
- /docs/intro.md
- /_config.yml
- /_toc.yml
- /markdown-notebooks.md
- /markdown.md
- /logo.png
- /LICENSE
parent b476751e
Branches main
No related tags found
No related merge requests found
This diff is collapsed.
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html
title: Plantilla Jupyter Book
author: MiLab
logo: logo.png
# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
execute_notebooks: force
# Define the name of the latex output file for PDF builds
latex:
latex_documents:
targetname: book.tex
# Add a bibtex file so that we can create citations
bibtex_bibfiles:
- references.bib
# Information about where the book exists on the web
repository:
url: https://gitmilab.redclara.net/hackathon-bella/plantillajupyterbook # Online location of your book
#path_to_book: docs # Optional path to your book, relative to the repository root
branch: main # Which branch of the repository should be used when creating links (optional)
# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
use_issues_button: true
use_repository_button: true
# Table of contents
# Learn more at https://jupyterbook.org/customize/toc.html
format: jb-book
root: docs/intro
parts:
- caption: Sesiones
numbered: True # Only applies to chapters in Part 1.
chapters:
- file: docs/sesion01/milab
docs/images/cyted1.png

111 KiB

docs/images/upload.png

447 B

# Creación de cursos con MkDocs
```{tableofcontents}
```
Este es un curso en el servicio [MiLab Pages](https://milab.redclara.net/). Puede revisar su [código fuente](https://gitlab.com/pages/mkdocs) y solicitar un despliegue nuevo con esta plantilla para sus proyectos llenando el siguiente formulario: [https://forms.gle/y33t6xb1vSKXQV4n8](https://forms.gle/y33t6xb1vSKXQV4n8).
## Tutorial de edición
> Esta plantilla se edita en formato MarkDown, puede usar la guía creada por [Matt Cone](https://github.com/mattcone) para conocer su sintaxis en [Guía rápida MarkDown](markdown.md)
Para la edición de los cursos se debe seguir estos pasos:
1. Dirigirse al repositorio del curso. Por ejemplo https://gitmilab.redclara.net/cyted/course1
2. Ingresar al editor web dando clic al botón **Web IDE**
![upload](images/cyted1.png "Web IDE")
3. Para editar archivos existentes, localizarlos en la carpeta `docs/` y realizar las ediciones necesarias.
4. Para nuevas paginas:
1. Se debe crear un nuevo archivo con extensión `.md` en el directorio `docs/`. Ejemplo `docs/documentacion.md`
2. Se debe agregar al menú desde el archivo `mkdocs.yml` en la sección `nav:` siguiendo el formato:
```
nav:
- Título: docs/archivo.md
```
5. Se pueden agregar imagenes, documentos o cualquier material complementario cargandolos desde el editor en el ícono ![upload](images/upload.png "Upload icon from https://www.flaticon.com/free-icon/upload_747416")
6. Para guardar los cambios:
1. Se da clíc al botón **Create Commit**
2. Se agrega una descripción de los cambios en el campo *Commit message*.
> Una frase corta que describe a grandes rasgos las mejoras añadidas
3. Se selecciona, Commit to **master** branch.
4. Se da clic al botón **Commit**
> A partir del commmit los cambios se reflejarán en la versión web en aproximadamente 5 minutos.
# Reproducibilidad `MiLab`
Plataforma MiLab, control de versiones, mensajería en escenarios de investigación, calculo computacional y datos de investigación para la ciencia abierta y reproducible.
logo.png

5.03 KiB

---
jupytext:
cell_metadata_filter: -all
formats: md:myst
text_representation:
extension: .md
format_name: myst
format_version: 0.13
jupytext_version: 1.11.5
kernelspec:
display_name: Python 3
language: python
name: python3
---
# Notebooks with MyST Markdown
Jupyter Book also lets you write text-based notebooks using MyST Markdown.
See [the Notebooks with MyST Markdown documentation](https://jupyterbook.org/file-types/myst-notebooks.html) for more detailed instructions.
This page shows off a notebook written in MyST Markdown.
## An example cell
With MyST Markdown, you can define code cells with a directive like so:
```{code-cell}
print(2 + 2)
```
When your book is built, the contents of any `{code-cell}` blocks will be
executed with your default Jupyter kernel, and their outputs will be displayed
in-line with the rest of your content.
```{seealso}
Jupyter Book uses [Jupytext](https://jupytext.readthedocs.io/en/latest/) to convert text-based files to notebooks, and can support [many other text-based notebook files](https://jupyterbook.org/file-types/jupytext.html).
```
## Create a notebook with MyST Markdown
MyST Markdown notebooks are defined by two things:
1. YAML metadata that is needed to understand if / how it should convert text files to notebooks (including information about the kernel needed).
See the YAML at the top of this page for example.
2. The presence of `{code-cell}` directives, which will be executed with your book.
That's all that is needed to get started!
## Quickly add YAML metadata for MyST Notebooks
If you have a markdown file and you'd like to quickly add YAML metadata to it, so that Jupyter Book will treat it as a MyST Markdown Notebook, run the following command:
```
jupyter-book myst init path/to/markdownfile.md
```
# Markdown Files
Whether you write your book's content in Jupyter Notebooks (`.ipynb`) or
in regular markdown files (`.md`), you'll write in the same flavor of markdown
called **MyST Markdown**.
This is a simple file to help you get started and show off some syntax.
## What is MyST?
MyST stands for "Markedly Structured Text". It
is a slight variation on a flavor of markdown called "CommonMark" markdown,
with small syntax extensions to allow you to write **roles** and **directives**
in the Sphinx ecosystem.
For more about MyST, see [the MyST Markdown Overview](https://jupyterbook.org/content/myst.html).
## Sample Roles and Directivs
Roles and directives are two of the most powerful tools in Jupyter Book. They
are kind of like functions, but written in a markup language. They both
serve a similar purpose, but **roles are written in one line**, whereas
**directives span many lines**. They both accept different kinds of inputs,
and what they do with those inputs depends on the specific role or directive
that is being called.
Here is a "note" directive:
```{note}
Here is a note
```
It will be rendered in a special box when you build your book.
Here is an inline directive to refer to a document: {doc}`markdown-notebooks`.
## Citations
You can also cite references that are stored in a `bibtex` file. For example,
the following syntax: `` {cite}`holdgraf_evidence_2014` `` will render like
this: {cite}`holdgraf_evidence_2014`.
Moreover, you can insert a bibliography into your page with this syntax:
The `{bibliography}` directive must be used for all the `{cite}` roles to
render properly.
For example, if the references for your book are stored in `references.bib`,
then the bibliography is inserted with:
```{bibliography}
```
## Learn more
This is just a simple starter to get you started.
You can learn a lot more at [jupyterbook.org](https://jupyterbook.org).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment