https://github.com/Enveloppe/wiki

https://github.com/Enveloppe/wiki

docs documentation documentation-site mkdocs obsidian obsidian-plugin obsidian-plugin-docs plugin workflow

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/Enveloppe/wiki
• Owner: Enveloppe
• License: gpl-3.0
• Created: 2025-01-06T08:00:47.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-03-23T09:29:10.000Z (3 months ago)
• Last Synced: 2025-04-07T21:41:05.551Z (3 months ago)
• Language: HTML
• Homepage: https://enveloppe.ovh/
• Size: 1.53 MB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Requirements

- Python 3.12 or higher

- [uv](https://docs.astral.sh/uv/)

> [!warning]

> As Netlify doesn't support Python past 3.8, the template **can't** be used with Netlify. 

> Only GitHub Page is officially supported.

# Installation

1. Click on "use this template"

2. Create the new repository from the template

3. [Generate a new GH token with the `repo` and workflow scope](https://github.com/settings/tokens/new?scopes=repo,workflow)

4. In Settings > Secrets and variables > actions 

 - Click on "New repository secret"

 - Name: `GH_TOKEN`

 - Value: ``

# Template generation 

1. In Actions, go "Generate Website" and click on "Run workflow".

2. Fill the items and click on "Run workflow"

3. Wait for the workflow to finish

If the auto-merging is not enabled:

- Read and validate the pull request, merge it.

- You can now go into "Publish" and click on "Run workflow" to publish the

  website.

# Enabling publishing with GH-Pages

In the `Settings`, go into `Pages` and:

- Set the **source** to "Deploy from a branch"

- Select the `gh-pages` branch, from root:

![image](https://github.com/user-attachments/assets/d65b6391-fb91-4306-a6cd-215298beb8b5)

> [!warning]

> You can't publish a private repository as a public page in the free tier of

> GitHub. But you can use a private submodule as your docs folder and publish it

> as a public page.

> If so, don't forget to set the `GH_TOKEN` secrets and enable the submodules in

> the `deploy.yml` file with setting `FETCH_SUBMODULE: true`