Getting Started

Zenodo user documentation uses Lektor, a powerful static content management system.

Install and running Lektor

Lektor can be installed either as an macOS desktop application or as a command line tool.

Desktop Application

Download and install the desktop application from Lektor's website.

Next, launch the application and browse to zenodo-docs-user.lektorproject in the root folder of the repository and open the file.

Command Line Tool

Copy/paste the following to your command prompt to install Lektor (or see Lektor's website for alternative ways):

$ curl -sf https://www.getlektor.com/install.sh | sh

Next, go into the root directory of the repository and run the following command and open http://localhost:5000/ in your browser afterwards:

$ lektor server

Documentation search with Pagefind

In order to test the documentation search functionality, install the pagefind[extended], beautifulsoup4 and requests packages and run the following commands:

$ lektor build
$ python pagefind_index.py "$(lektor project-info --output-path)"
$ python -m http.server --directory "$(lektor project-info --output-path)"

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.