Learn how to use Earthdaily platform capabilities within your business workflows! Cloud-native Earth observation with trusted data, flexible analytics, and seamless API integration.
Table of Contents
To be able to run this project locally , you will need to have following tools installed:
-
Install Conda: please install Conda on your computer. You can download and install it by following the instructions provided on the official Conda website
-
Install Git: please install Github on your computer. You can download and install it by visiting <a href=https://desktop.github.com/here> and following the provided instructions
This project has been tested on Python 3.11
To set up this project, follow these steps:
-
Clone the project repository:
git clone https://github.com/earthdaily/earthdaily-documentation -
Create the required Conda environment:
conda create --name documentation python=3.11 -
Activate the Conda environment:
conda activate documentation -
Install mkdocs-material:
pip install mkdocs-material -
Navigate to the local project folder
cd <path to project folder> -
Intall dependencies from requirement.txt
pip install -r requirements.txt
To run the website locally, you use the following command:
-
Open a terminal in the project folder.
-
Activate the Conda environment:
conda activate documentation -
Serve locally:
mkdocs serve -
Open your browser
http://127.0.0.1:8000/documentation/
To create new pages, just add new markdown files to the docs folder of the repository and edit them.
MkDocs will then turn those into static HTML pages once you build or deploy the pages.
If you are usingd VS code to update content please open site folder. Once done, you will benefit from auto completion and image preview.
A deployment workflow has been configured to build and deploy website on each commit to main branch.
This workflow will setup Python, download Material for MkDocs and all its dependencies and deploy the pages to the gh-pages branch to then be viewable under this URL.
The repository contains a dependabot.yml file inside the .github folder which allows automatic updates through GitHub's Dependabot.
It is configured to target both Python dependencies (inside the requirements.txt) and GitHub Actions dependencies, to make sure bot are updated accordingly.
Note that it is configured by default to add the Type: Update (Dependency) label and also the Target: Python (pip) label for Python and Target: GitHub Actions label for GitHub Actions Dependencies.
Those labels don't exist by default so you have to either create them, or alter the ones in the dependabot.yml (You can also just remove the labels sections).
The following links will provide access to more information:
- Markdown foundations
- Mkdocs
- Mkdocs Material
- Examples on how to create rich documentation content using charts, badges
Tips To generate folder structure with ASCII characters, you can use the command 'tree".
- Open the Command Prompt (Start button + type "cmd").
- Navigate to the desired root directory using the cd command. For example, to go to C:\MyDocuments
- Execute the tree command with the /f and /a switches, redirecting the output to a text file. The /f switch displays the names of files in each folder, and /a uses ASCII characters for the tree structure:
tree /f /a > FolderStructure.txt
If this project has been useful, that it helped you or your business to save precious time, don't hesitate to give it a star.
Distributed under the MIT License.
For any additonal information, please email us.
© 2026 Geosys Holdings ULC, an Antarctica Capital portfolio company | All Rights Reserved.