hedgedoc/hedgedoc.github.io

The landing page at hedgedoc.org

HedgeDoc lets you create real-time collaborative markdown notes.

Getting Started

• ℹ️ Read all about HedgeDoc and the history of the project on our website
• 🧪 Try out HedgeDoc with the demo instance. Check out the features page!
• 💽 Install HedgeDoc yourself using the install guide
• ❓ Questions? Join our Matrix chat or the community forums
• 💬 Stay up to date by subscribing to the release feed

State of the project

HedgeDoc 1.x is stable and used around the world, but the codebase has grown over time, making it hard to add new features.
We are currently working on HedgeDoc 2, a complete rewrite of HedgeDoc. Please note the following:

• This branch contains the latest development code and does not implement all features yet. If you are looking for the 1.x source code, have a look at the master branch.
• The 1.x release is maintenance-only. We do not accept feature requests or PRs for this release anymore and may choose to close non-critical bug reports, if the bug will be non-existent in 2.0.
• HedgeDoc 2 will be split in two components. The backend and the frontend. Both are present in this repository.

Development

Information for setting up a local development environment can be found in the developer documentation

HedgeDoc 2 Alpha

Curious about the new look and feel of HedgeDoc 2? We provide a demo of the alpha on hedgedoc.dev.

If you want to try it out on your own devices, visit the HedgeDoc 2 docs. But be aware that these may change over time.

Contributions

We welcome contributions!
Have a look at our contribution docs to find out how you can help. If you want to contribute to HedgeDoc 2, please join our development chat.

License

Licensed under AGPLv3. For our list of contributors, see AUTHORS.

The license does not include the HedgeDoc logo, whose terms of usage can be found in the github repository.

hedgedoc.github.io's Issues

dark theme

I think that it would be nice to provide a dark theme for the website (and the doc, later) using the prefers-color-scheme media query.

However, as bootstrap is defining colors of the theme in a lot of places and not using variables, it may be difficult to make sure that all colors are right.
The fact that the logo in the upper left corner is an image (with transparent background) also makes difficult to write a dark css theme as the text can't be seen anymore with a dark background.

Add docker image tag to releases page

The new releases (and download) page does contain a hint about our docker image. The section currently only includes a link to quay.io. I'd like to see the corresponding docker image tag directly on the releases page.

For accomplishing that we either need to push pre-1.6 versions to hedgedoc/hedgedoc as well or differentiate in our hugo template whether codimd/server or hedgedoc/hedgedoc needs to be used.

Optionally we also could the quay.io-API to check whether the image tag exists.

add a readme

this should explain

• how to build the page
• how to contribute to it (bugs, changes, etc)
• …

add a screenshot to the landing page

We should add a screenshot or two to the landing page. Yes, people can click right through to the demo, but I still think that a visual cue what to expect would be nice.

releases should also mention the date when it was published

On release pages like the list
https://hedgedoc.org/releases/

or individual releases
https://hedgedoc.org/releases/1.8.2/

It's currently not possible to see, how old a release is. I would like to request adding a date to the list and/or the release page.

Add labels and PR templates

It would be nice if we copy the labels and PR templates from the other projects or create new ones.

Release Page: Always show release notes

Currently, the release notes are hidden behind a details-click-thingy. As the release notes often contain important information about upgrading, they should not be hidden by default.
We already had a few support cases where people missed the note about X-Forwarded-Proto headers in the release notes.

add a ci

we should add a CI that builds the page to ensure a minimum of bugs and errors

add docs

we should add the docs to this page

see https://erikmichelson.github.io/codimd/#/ for an example how this maybe structured.

Add releases

We should find a way to provide releases and/or release notes on our website.

We can probably utilise the GitHub API to get the name of the release as well as a link to the release notes.

This could help people to find them without being "GitHub aware".

Canonical URLs

We should add the canonical link tag to the website head. This is helpful for search engines.

Release page: Don't call the .tar.gz 'precompiled'

Our release bundle contains the frontend bundle since 1.7.
Calling that "precompiled" is technically wrong and confusing.
Compilation means that architecture-specific object code is generated, which is not the case for our frontend bundle. Users might think that our release bundle is in some way architecture-specific, if we refer to compilation.

We should omit the word "precompiled" from the release page. Instead we could use "Ready to use archive" as the heading and "Includes pre-build frontend bundle" as a note below that.

Improve sitemap

Currently the sitemap only contains the URLs of the pages, but it can also include stuff like priority, lastupdate, change frequency, which is very helpful for search engines. This parameters can be added via the front matter in the content files.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update dependency bootstrap to v5.3.3
• fix(deps): update fonts (@fontsource/kumbh-sans, @fontsource/lato)
• chore(deps): update dependency gohugoio/hugo to v0.125.6
• fix(deps): update dependency typescript to v5.4.5
• fix(deps): update dependency yaml to v2.4.2
• chore(deps): update fsfe/reuse-action action to v3
• chore(deps): update peaceiris/actions-gh-pages action to v4
• chore(deps): update peaceiris/actions-hugo action to v3
• chore(deps): lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/deploy.yml

• actions/checkout v4
• peaceiris/actions-hugo v2
• actions/setup-node v4
• actions/cache v4
• peaceiris/actions-gh-pages v3

.github/workflows/link-check.yml

• actions/checkout v4
• peaceiris/actions-hugo v2
• actions/setup-node v4
• actions/cache v4

.github/workflows/reuse.yml

• actions/checkout v4
• fsfe/reuse-action v2

npm

package.json

• @fontsource/kumbh-sans 5.0.14
• @fontsource/lato 5.0.18
• bootstrap 5.3.2
• fork-awesome 1.2.0
• node-fetch 3.3.2
• ts-node 10.9.2
• typescript 5.3.3
• yaml 2.3.4
• @types/node-fetch 2.6.11

nvm

.nvmrc

• node 20

regex

.github/workflows/deploy.yml

• gohugoio/hugo 0.122.0

---

• Check this box to trigger a request for Renovate to run again on this repository

History page: s/aboutt/about/

https://hedgedoc.org/history/

Add lighthouse github action

Lighthouse is an website audit tool, that tells you what you could improve to increase usability and SEObility.

Link to /releases

As I just (re)discovered it's currently not possible to click you way from the homepage to https://hedgedoc.org/releases/, which I think should be changed.

add a license to this repo

Authenticate ownership with links

We could consider to add rel="me" to some of the menu and footer links.

For example the link on Mastodon could verified for the account, if the link would be available with rel="me" attribute (and use the direct instance URL instead of social.hedgedoc.org)

Remove active border on menu

The menu button looks quite strange while being in the active state:

History page: pendant -> counterpart maybe?

https://dict.leo.org/englisch-deutsch/pendant

Drop Google Fonts

Make our links more present on the landing page

Currently the links to our used services are split into the header navbar and the footer.
IMHO it would be more welcome if we place the links more present in a section on the landing page. With icons, description and fairy dust (optional) ✨.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: renovate.json
Error type: The renovate configuration file contains some invalid settings
Message: Regex Manager contains disallowed fields: extractVersion

fix css on doc

The docs have a ugly css bug