--- /dev/null
+---
+title: "BookStack: An Open Source Alternative to Confluence"
+image: "/images/about/books-view.png"
+---
+
+
+<div class="container">
+ <div class="padded-top">
+ <h2 class="margin-bottom large">What BookStack <br> Offers</h2>
+ <p> </p>
+
+
+ <div class="row">
+ <div class="col-sm-4">
+ <h4>Free and Open Source</h4>
+ <p>
+ BookStack is 100% free to use under the MIT license.
+ The code is fully open; Use and modify BookStack any way you
+ like, just provide attribution if you distribute the code.
+ </p>
+ </div>
+ <div class="col-sm-4">
+ <h4>Self-Host However You Please</h4>
+ <p>
+ There's no push to the cloud here unless that's your preference.
+ Whether you install on a Raspberry Pi, or stick it in AWS; It's fully up to you.
+ You can ensure your documentation stays behind your firewall.
+ </p>
+ </div>
+ <div class="col-sm-4">
+ <h4>Lightweight and Speedy</h4>
+ <p>
+ Tired of seeing placeholder content while your pages load? Tired of managing bloated Java processes? BookStack is built in modern PHP and can run on lightweight systems.
+ </p>
+ </div>
+ </div>
+
+ <p>
+ <br>
+ </p>
+
+ <div class="row">
+ <div class="col-sm-4">
+ <h4>WYSIWYG Editing Experience</h4>
+ <p>
+ BookStack uses a WYSWIYG editor at it's core, with a range of essential formatting options and features. No scary mark-up language. Ideal for mixed-skill environments.
+ </p>
+ </div>
+ <div class="col-sm-4">
+ <h4>Standard Content Storage Format</h4>
+ <p>
+ BookStack primarily retains content in a relatively focused and flat layer of HTML. One of our ideals is to keep the format relatively standardised for if you ever need to migrate away from BookStack.
+ </p>
+ </div>
+ <div class="col-sm-4">
+ <h4>System API</h4>
+ <p>
+ Our growing REST API allows the programming of automation where desired, and provides a mechanism for import where needed.
+ </p>
+ </div>
+ </div>
+
+
+ <p>
+ <br>
+ </p>
+
+
+ <div class="row">
+ <div class="col-sm-4">
+ <h4>An Open Community</h4>
+ <p>
+ Whether it's via GitHub, Discord or our subreddit, you can discuss with and seek help from the BookStack developers & the wider community.
+ </p>
+ </div>
+ <div class="col-sm-4">
+ <h4>Diagrams.net Integration, Built In</h4>
+ <p>
+ Want to create diagrams in your documentation? You can jump directly into an embedded <a href="https://www.diagrams.net/">diagrams.net</a> editing
+ session which will save directly into BookStack.
+ </p>
+ </div>
+ <div class="col-sm-4">
+ <h4>Authentication Options</h4>
+ <p>
+ A range of authentication options and controls are built-in including LDAP, SAML2 and a range of OAuth clients. Additionally MFA with role-based enforcement can be used with any of these.
+ </p>
+ </div>
+ </div>
+
+
+ <div class="row padded-vertical large">
+ <div class="col-sm-6">
+ <p class="text-center">
+ <a href="https://github.com/BookStackApp/BookStack">GitHub</a> |
+ <a href="https://demo.bookstackapp.com">Demo Instance</a> |
+ <a href="/docs/admin/installation">Installation Instructions</a>
+ </p>
+ </div>
+
+ <div class="col-sm-6">
+ <p class="text-center">
+ <a href="/">
+ Read more and see screenshots on our homepage »
+ </a>
+ </p>
+ </div>
+
+ </div>
+
+ </div>
+</div>
+
+
+<div class="shaded shaded-border padded-vertical large">
+ <div class="container pb-l">
+ <h2>Migrating From Confluence to BookStack</h2>
+
+ <p class="margin-bottom large">
+ We don't yet have an automated way to migrate your content directly from Confluence to BookStack. <br>
+ We do have a growing REST API that can be used to automate some of the process where possible. <br>
+ In the future we'd like to have some tools to assist with a migration but the opportunity <br> to create such tools has not yet presented itself.
+ </p>
+
+ </div>
+</div>
+
+
--- /dev/null
+version https://git-lfs.github.com/spec/v1
+oid sha256:0ed43de00c4be14e2de506773bb32bacf89a7a00c717a8e1ace00e71c5ab9f1a
+size 391978
<div class="row">
<div class="col-sm-6">
{{ if eq .Type "admin-doc" }}
- <h2 class="thin-margin">Admin Documentation</h2>
+ <h1 class="thin-margin">Admin Documentation</h1>
{{end}}
{{ if eq .Type "user-doc" }}
- <h2 class="thin-margin">User Documentation</h2>
+ <h1 class="thin-margin">User Documentation</h1>
{{end}}
</div>
<div class="col-sm-6">
--- /dev/null
+{{ partial "header.html" . }}
+
+{{ $baseurl := .Site.BaseURL }}
+
+<div class="no-cover">
+
+ <div class="container">
+ <h1>"About BookStack" Pages</h1>
+ <h2 class="page-description">
+ {{if .Params.description}}
+ {{.Params.description}}
+ {{end}}
+ </h2>
+ </div>
+</div>
+
+<div class="container">
+ {{ $paginator := .Paginator }}
+
+ {{ range $paginator.Pages }}
+ {{ $baseurl := .Site.BaseURL }}
+ <article class="post {{ .Section }}">
+ <div class="post-header">
+ <h5 class="post-title"><a href="{{ .RelPermalink }}">{{ .Title }}</a></h5>
+ </div>
+ </article>
+
+ {{ end }}
+
+ <div class="row">
+ <div class="col-md-4">
+ {{ partial "pagination" $paginator }}
+ </div>
+ </div>
+</div>
+
+{{ partial "footer.html" . }}
\ No newline at end of file
--- /dev/null
+{{ partial "header.html" . }}
+
+<div class="header">
+ <div class="container">
+ <div class="row hero">
+ <div class="col-md-4 spaced">
+ <h1>{{.Title}}</h1>
+ </div>
+ <div class="col-md-8 screenshot-container-parent">
+ <div class="screenshot-container">
+ <div class="window-row">
+ <div class="window-option red"></div>
+ <div class="window-option" style="background-color: orange;"></div>
+ <div class="window-option" style="background-color: green;"></div>
+ </div>
+ {{ if .Params.image }}
+ <img class="screenshot" src="{{.Params.image}}" alt="{{.Title}}">
+ {{ end }}
+
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ {{.Content}}
+
+{{ partial "footer.html" . }}
<div class="container">
<div class="row hero">
<div class="col-md-4 spaced">
- <h2>Simple & Free <br>Wiki Software</h2>
+ <h1>Simple & Free <br>Wiki Software</h1>
<p>BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information.</p>
<p>
<a href="https://github.com/BookStackApp/BookStack">GitHub</a> -
<div class="row">
<div class="col-md-6">
<p class="text-small">
- This website uses a self-hosted instance of <a href="https://plausible.io/" target="_blank" rel="noreferrer">Plausible</a> for analytics.
- Our site stats can <a href="https://analytics.bookstackapp.com/bookstackapp.com" target="_blank" rel="noreferrer">be viewed here</a>.
- <br>
- We also use <a href="https://docsearch.algolia.com/" target="_blank" rel="noreferrer">Algolia</a> for providing better search.
+ Latest Blog Post:
+ {{ range first 1 ( where .Site.Pages "Section" "blog") }}
+ <a href="{{.Permalink}}">{{ .Title }}</a>
+ {{ end }}
+ |
+ <a href="/about/confluence-alternative">BookStack: A Confluence Alternative</a>
</p>
</div>
<div class="col-md-6 text-right">
<iframe src="https://github.com/sponsors/ssddanbrown/button" title="Sponsor ssddanbrown" height="35" width="116" style="border: 0;margin-top: 1rem;" loading="lazy"></iframe>
</div>
</div>
+ <p class="text-small">
+ This website uses a self-hosted instance of <a href="https://plausible.io/" target="_blank" rel="noreferrer">Plausible</a> for analytics.
+ Our site stats can <a href="https://analytics.bookstackapp.com/bookstackapp.com" target="_blank" rel="noreferrer">be viewed here</a>.
+
+ We also use <a href="https://docsearch.algolia.com/" target="_blank" rel="noreferrer">Algolia</a> for providing better search.
+ </p>
</div>
</footer>
{{ $baseURL := .Site.BaseURL }}
- {{ if .IsPage }}
+ {{ if and (.IsPage) (ne .Type "about") }}
{{ with .Params.image }}
<!-- Twitter summary card with large image must be at least 280x150px -->
<div class="logo">
<a href="{{.Site.BaseURL}}">
{{partial "icon/logo.svg"}}
- <h1>BookStack</h1>
+ <div>BookStack</div>
</a>
</div>
<div class="row">
<div class="col-sm-6">
{{if eq .Page.Type "admin-doc"}}
- <h2 class="thin-margin">Admin Documentation</h2>
+ <h1 class="thin-margin">Admin Documentation</h1>
{{else if eq .Page.Type "user-doc"}}
- <h2 class="thin-margin">User Documentation</h2>
+ <h1 class="thin-margin">User Documentation</h1>
{{else}}
- <h2 class="thin-margin">Documentation</h2>
+ <h1 class="thin-margin">Documentation</h1>
{{end}}
top: 0;
background-color: $primary-dark;
color: #fff;
- h2 {
+ h1 {
color: #FFF;
- font-size: 2.666em;
+ font-size: 2.666rem;
font-weight: 300;
@include smaller-than($s) {
font-size: 2em;
.spaced {
margin-top: $-xxl;
margin-bottom: $-l*2;
- h2, p {
+ h1, p {
max-width: 420px;
}
@include smaller-than($screen-lg) {
.logo {
text-align: left;
margin: $-m 0;
- h1, img {
+ div, img {
vertical-align: top;
display: inline-block;
margin: 0;
}
- h1 {
+ div {
color: #FFF;
font-size: 1.8em;
font-weight: 400;
@include smaller-than($s) {
margin: $-s 0;
- h1 {
+ div {
font-size: 1.8em;
}
svg {
padding-top: $-l;
padding-bottom: $-l;
p {
- padding: $-m;
+ padding: $-m 0;
margin: 0;
}
}
projects / website / commitdiff