Overview of OpenSquiggly and how you might use it on your team.

Getting started

Overview of the OpenSquiggly public portal and self-hosted (e.g., private portal) options.

Self-Hosted Portals

How to install OpenSquiggly in your own cloud or on-premise environment.

Kubernetes How-To Guides

How to set up your Kubernetes cluster for extra functionality.

Post-Installation Configuration

How to configure optional settings after installing OpenSquiggly.

Mounting Source Repos

How to bring source code repositories from Git hosting systems into your OpenSquiggly portal.

Mounting Doc Repos

How to bring externally-hosted documentation stored in Git repositories into your OpenSquiggly account. If you author documents in Markdown, HTML, or XML, OpenSquiggly can retrieve documentation from multiple locations and bring them together into one common portal.

Multiple Mounts with Manifests

How to quicly add large numbers of mount points using manifest files.

Authoring Documents

How to author documents within the OpenSquiggly portal. This works very similarly to using a wiki to author and store documents. OpenSquiggly supports both workflows, externally-hosted or internally-authored.

Managing the Document Tree

How to navigate and customize your document tree. This section explains how you can add new types of pages to your document tree, navigate around the tree, and move or copy document links to other parts of the tree.

Searching Files

OpenSquiggly features a robust code search engine that allows you to perform regular-expression-based searches of your documents, and filter the results by various criteria.

Sharing Content

How to share pages and files with other users.

Page Theory

OpenSquiggly features a unique and flexible page paradigm that allows developers to create highly customized views of their information. In this section we cover the underlying theory of how OpenSquiggly works at the fundamental level of pages and snippets.