Skip to content
forked from docmost/docmost

Forkmost is a fork of Docmost which is an open-source collaborative wiki and documentation software. It is an open-source alternative to Confluence and Notion.

License

Notifications You must be signed in to change notification settings

Vito0912/forkmost

 
 

Repository files navigation

Forkmost

Note

This is a custom, updated fork of Docmost, optimized for personal and educational use, especially for sharing with multiple different users. It also includes features that Docmost is either "too" slow to add or chooses not to include, sometimes because they are behind a paywall or because Docmost aims to "keep it simple." (No judgment)

I cannot promise that I will keep maintaining this fork forever as I primarily do it for myself, but I will do so as long as the license allows and I actively use Docmost. I have also taken out some features that others might find helpful, and I may have added some bugs. As per license this can be forked at any time

For added and features merged ahead, see the note under Features.

Forkmost

Open-source collaborative wiki and documentation software.

View the awesome original project (not associated with this fork other than being a fork of Docmost): Docmost

Renaming was done to avoid confusion and comply with trademark rights with the original project. Forkmost does not have any cloud nor enterprise features and is intended for personal use.


Getting started

To get started with Forkmost, please refer to the Docmost documentation.

Versioning

Forkmost uses the same versioning as upstream. The tags use this format: vX.Y.Z.W, where:

  • X, Y, and Z are the version numbers from upstream
  • W is the version number for this fork, starting at 0 for each new upstream release and increasing with each minor release in this fork

For Docker, these tags are available:

  • dev - The newest development version of Forkmost. It should be stable, but it might have bugs.
  • latest - The newest stable version of Forkmost. This matches vX.Y.Z.W.
  • vX.Y.Z.W - A specific version of Forkmost.
  • vX.Y.Z - The newest version of Forkmost for the upstream version X.Y.Z. This matches vX.Y.Z.latest.

Important

Rolling back to Docmost is not supported and has not been tested. It is unclear if the migrations will work if you try to return to Docmost. Even if they do work, all blocks that were added in Forkmost but do not exist in Docmost will be lost and cannot be recovered.
This includes, but is not limited to, the following blocks: Highlight, Audio, Column layout, and more.

Features

Core Features

  • Real-time collaboration
  • Diagrams (Draw.io, Excalidraw, and Mermaid)
  • Spaces
  • Permissions management
  • Groups
  • Comments
  • Page history
  • Search
  • File attachments (Video, audio, images, PDF)
  • Embeds (Airtable, Loom, Miro, and more)
  • Translations (10+ languages)
  • public sharing (with optional password protection)
  • free SSO with OIDC (tested with Authentik)

Fork-Specific Enhancements

Expand for merged or pre-fork pull requests
  • "Docmost" branding removed from the editor when sharing (moved to header as "Forkmost")
  • Users not in the same space (and without at least edit permissions) are hidden
  • Group members are hidden unless you are an admin or owner
  • Allow users to change their email address
  • Open links in edit mode with Ctrl
  • Added audio extension support1
  • Use more blocks in tables (e.g., bullet list, todo, etc.)
  • Custom emoji in callouts
  • More options for code blocks (see details)
  • PWA support (based on)
  • Anchor link support for page mentions
  • Password-protected pages
  • PDF embedding support. Allows to set PDFs for all participants to view


Merged or Pre-Fork Pull Requests

Expand for merged or pre-fork pull requests

List as follows2:

  • ctrl/cmd-s by fuscodev3
  • shared-page-width-toggle by sanua356
  • extra-ligatures by Webblitchy
  • highlight-support by fuscodev4
  • float-image by fuscodev1
  • add-more-headings by sanua3565
  • anchor-link by fuscodev6
  • forkmost/aside-pref by fuscodev
  • forkmost/breadcrumb-mentions by fuscodev
  • sanitize-tree-export-space by fuscodev
  • forkmost/find-and-replace by fuscodev7
  • forkmost/colum-layout by fuscodev1
  • forkmost/spellcheck-pref by fuscodev


License

Docmost core is licensed under the open-source AGPL 3.0 license.

Enterprise features (meaning the code not the features itself) from upstream are not allowed due to Docmost license. Pull requests that add enterprise (everything in ee files) features will not be accepted and checks will not pass. See the original license here.

Contributing

See the development documentation of Docmost which Forkmost follows

Thanks

Major thanks to @fuscodev, who contributed their changes from upstream themselves. Also, many pull requests I merged are based on their work.

Many thanks to @Philipinho for the great base, general features, and the good codebase to work with.

Also see Docmost#Thanks

Footnotes

  1. Do not use if you plan to revert to upstream in the future. This is added to features that are not in upstream at the moment or never will. You should be able to always go back to upstream, but used blocks e.g. then are lost and not recoverable. 2 3

  2. Footnotes are used to indicate any changes made to the original pull request or any additional information.

  3. Force saving will save directly to the database

  4. Clicking default colors automatically applies highlight color to make it easier to use

  5. The Table of Contents (ToC) only displays the first 3 levels of headings.

  6. The UI for copying redesigned; scrolling is now faster.

  7. Updated UI and shortcuts for find and replace and better UX - Focus

About

Forkmost is a fork of Docmost which is an open-source collaborative wiki and documentation software. It is an open-source alternative to Confluence and Notion.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • TypeScript 96.4%
  • CSS 3.3%
  • Other 0.3%