]> BookStack Code Mirror - website/commitdiff
Added bookstack alternatives page
authorDan Brown <redacted>
Fri, 9 Feb 2024 21:43:06 +0000 (21:43 +0000)
committerDan Brown <redacted>
Fri, 9 Feb 2024 21:43:06 +0000 (21:43 +0000)
content/about/bookstack-alternatives.md [new file with mode: 0644]
themes/bookstack/layouts/partials/footer.html

diff --git a/content/about/bookstack-alternatives.md b/content/about/bookstack-alternatives.md
new file mode 100644 (file)
index 0000000..b45ba32
--- /dev/null
@@ -0,0 +1,51 @@
+---
+title: "Other Open Source Documentation Platforms"
+---
+
+BookStack is not the solution for everyone, and we don't intend to be.
+The right platform for your documentation can be very specific to your content, audiences, use-case, and preferences.
+It's usually best to trial a range of options to see what works best for you.
+
+Below we've listed a range of wonderful alternative fully free and open source options that may be worth reviewing.
+We won't rank or compare these, since we'll naturally have a biased view and such comparisons can lack nuance as
+to what makes each option great, so it's best to discover the styles & benefits of each platform for yourself 
+to see how they fit your use-case.
+
+- **[Wiki.js](https://js.wiki/)** - A modern, lightweight and powerful wiki app built on NodeJS.
+- **[Pepperminty Wiki](https://peppermint.mooncarrot.space/)** - A complete wiki engine contained in a single (PHP) file.
+- **[DokuWiki](https://www.dokuwiki.org/dokuwiki)** - A simple to use and highly versatile wiki software that doesn't require a database.
+- **[MediaWiki](https://www.mediawiki.org/wiki/MediaWiki)** - The solution powering Wikipedia.
+- **[Trilium Notes](https://github.com/zadam/trilium)** - A hierarchical note taking application with focus on building large personal knowledge bases.
+- **[Zim](https://zim-wiki.org/)** - A desktop graphical text editor used to maintain a collection of wiki pages.
+- **[Notesnook](https://notesnook.com/)** - An end-to-end encrypted note taking app focused on user privacy & ease of use.
+- **[TiddlyWiki](https://tiddlywiki.com/)** - A non-linear personal web notebook.
+- **[wikimd](https://github.com/Linbreux/wikmd)** -  A file based wiki that uses markdown.
+- **[XWiki](https://www.xwiki.org/)** - A generic platform for developing projects and collaborative applications using the wiki paradigm.
+- **[Otter Wiki](https://github.com/redimp/otterwiki)** - A minimalistic wiki powered by python, markdown and git. 
+
+### Static Site Generators
+
+Using a specific wiki/documentation platform may not always be the most suitable option.
+If your editors are primarily developer-focused, and you have a specific vision that you want build to,
+static site generators can often be a great solution that provides a lot of control over the output.
+These are systems used to build websites from a range of markdown (or other format) content.
+We even use one (Hugo) for this website, blog and documentation pages!
+Here are some popular options in this area:
+
+- **[Hugo](https://gohugo.io/)** - A fast static generator built on Go.
+- **[Docusaurus](https://docusaurus.io/)** - A static-site generator leveraging the full power of React.
+- **[MkDocs](https://www.mkdocs.org/)** - A static site generator that's geared towards building project documentation.
+- **[11ty](https://www.11ty.dev/)** - A simpler static site generator built on NodeJS.
+- **[VitePress](https://vitepress.dev/)** - Vite & Vue Powered Static Site Generator.
+
+
+### Other Forms of Documentation
+
+Documentation isn't fixed to a specific format, there are loads of formats that can be used to document,
+many of which you may find more fun. The best form is the one you'll actually use.
+A good example of this is a blog, which you could use to document ideas and projects as you go.
+Over time this can build up to become a useful repository of information and documentation that you
+can refer back to.
+
+For some other ideas like using forums, GitHub issues, and videos, you can read our 
+["A Look at Some Interesting Documentation Methods" blogpost](/blog/interesting-methods-of-documentation/).
index 5f1985e7f21057423cb685a01095ef90b5a81a3f..081d75fd8a331f54f0cd2e056aad2f082f2cc17f 100644 (file)
                     <h5>Information</h5>
                     <ul class="nav-list">
                         <li><a href="/about/project-faq/">Project FAQ</a></li>
+                        <li><a href="/support/">Our Support Services</a></li>
+                        <li><a href="/about/bookstack-alternatives/">Alternative Open Source Options</a></li>
                         <li><a href="/about/confluence-alternative/">A Confluence Alternative</a></li>
                         <li><a href="/about/teams-wiki-alternative/">Microsoft Teams Wiki Alternative</a></li>
                         <li><a href="/about/open-source-documentation-software/">Open Source Documentation Software</a></li>
-                        <li><a href="/support/">Our Support Services</a></li>
                     </ul>
                </div>
             </div>