Skip to content

PumasAI-Labs/Workshop-Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Pumas-AI Workshop Templates

CC BY-SA 4.0

How to use this template

  1. Click on the green button Use this template
  2. Edit all the PLACEHOLDER in mkdocs.yml with respect to site_name, repo_name and repo_url.
  3. Edit all the PLACEHOLDER in docs/index.md, docs/reference.md and docs/instructor.md.
  4. Add appropriate content to docs/index.md, docs/reference.md and docs/instructor.md.

How to contribute

We use Material for MkDocs (MIT License) as the static site generator.

  1. Clone the repository
  2. Install Material for MkDocs with pip install mkdocs-material
  3. Create or review content
  4. Preview the site with mkdocs serve
  5. Make a Pull Request

Maths

This template is already configured for MathJax to work, both using inline and block syntax.

Authors

License

This content is licensed under Creative Commons Attribution-ShareAlike 4.0 International.

CC BY-SA 4.0