diff --git a/README.md b/README.md index 41c4f26..d5da94d 100644 --- a/README.md +++ b/README.md @@ -15,24 +15,18 @@ https://elixir-europe-training.github.io/ELIXIR-TrP-LessonTemplateInstructions-M This website is generated with [MkDocs](https://www.mkdocs.org/), with the theme [Material](https://squidfunk.github.io/mkdocs-material/). -To host it locally, install MkDocs: -```bash -pip3 install mkdocs -``` +To host it locally, clone this repository to your local computer. Install the required dependencies by runnning: -and Material with some plugins: ```bash -pip3 install mkdocs-material mkdocs-bibtex neoteroi-mkdocs mkdocs-video mkdocs-include-markdown-plugin mkdocs-markdownextradata-plugin mkdocs-macros-plugin +pip install -r requirements.txt ``` -Clone this repository to your local computer. Then, make the repository your current directory and type: +Next, you can launch the website by making the repository your current directory and typing: ```bash mkdocs serve ``` -To host it locally. - Check it out with your browser at [http://localhost:8000/](http://localhost:8000/). diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..ef45da1 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,9 @@ +mkdocs +mkdocs-material +mkdocs-bibtex +neoteroi-mkdocs +mkdocs-video +mkdocs-include-markdown-plugin +mkdocs-markdownextradata-plugin +mkdocs-macros-plugin +mkdocs-site-urls