Migrate docs to the new format

presslabs · Oct 20, 2019 · 2bc4b15 · 2bc4b15
1 parent bf375a0
commit 2bc4b15
Show file tree

Hide file tree

Showing 8 changed files with 159 additions and 25 deletions.
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/_index.md b/docs/_index.md
@@ -0,0 +1,10 @@
+---
+title: What is Gitfs
+linktitle: What is Gitfs
+description: Gitfs is a fuse file system that fully integrates with git
+categories: [gitfs]
+keywords: [gitfs, versioned filesystem, git filesystem, fuse, linux filesystem, macos filesystem]
+toc: false
+related: false
+layout: documentation-home
+---
diff --git a/docs/documentation/arguments.md → docs/arguments.md b/docs/documentation/arguments.md → docs/arguments.md
@@ -1,3 +1,17 @@
+---
+title: Arguments
+linktitle: Arguments
+description: A list with all arguments for Gitfs
+categories: [gitfs]
+keywords: [gitfs, arguments, usage]
+weight: 4
+draft: false
+aliases: []
+toc: true
+related: true
+slug: arguments
+---
+
 ## Using options
 
 In order to use options when mounting gitfs, you need to append the options as an argument when using the mount command like this:

diff --git a/docs/config.toml b/docs/config.toml
@@ -0,0 +1,92 @@
+baseURL = "https://www.presslabs.com/code/gitfs/"
+languageCode = "en-us"
+title = "Gitfs DOCS"
+summaryLength = 15
+metaDataFormat = "yaml"
+theme = "docs"
+enableRobotsTXT = true
+enableGitInfo = true
+pygmentsCodeFences = true
+pygmentsOptions = ""
+pygmentsUseClasses = true
+pygmentsUseClassic = false
+pygmentsStyle = "github"
+dataDir = "/site/data"
+
+[params]
+  site_url = "https://www.presslabs.com/code/"
+  legal_url = "https://www.presslabs.com/legal"
+  breadcrumbs_root = "Gitfs DOCS"
+  quick_start = true
+  quick_start_link = "what-is-gitfs/"
+  logo_text = "CODE"
+  search_placeholder = "Search code"
+  footer_menu = true
+  footer_menu_title = "DOCUMENTATION"
+  title = "Welcome to Gitfs Documentation!"
+  description = "Gitfs is a fuse filesystem that fully integrates with git"
+  release = "0.5.1"
+  # debug = true
+  algolia_search = true
+  algolia_appId = "0TS6NFHDBC"
+  algolia_apiKey = "099bffdf3b4a6ea94ddbea10f73dd15a"
+  algolia_indexName = "Gitfs Docs"
+  algolia_currentLanguageOnly = true
+  images = ["images/code.jpg"]
+
+[params.algolia]
+  vars = ["title", "description", "summary", "content", "date", "lastmod", "permalink", "text", "lvl0", "lvl1", "url"]
+  params = ["categories", "keywords"]
+
+[blackfriday]
+  angledQuotes = true
+  extensions = ["hardLineBreak"]
+  sourceRelativeLinks = true
+  fractions = false
+  plainIDAnchors = true
+
+[outputFormats.Algolia]
+  baseName = "algolia"
+  isPlainText = true
+  mediaType = "application/json"
+  notAlternative = true
+
+[outputs]
+  home = [ "HTML", "RSS", "JSON", "Algolia" ]
+
+[taxonomies]
+  category = "categories"
+
+[related]
+  threshold = 80
+  includeNewer = true
+  toLower = false
+
+[[related.indices]]
+  name = "keywords"
+  weight = 150
+
+[[menu.docs]]
+  name = "What is Gitfs"
+  weight = 1
+  url = "/what-is-gitfs/"
+
+[[menu.docs]]
+  name = "How it works"
+  weight = 2
+  url = "/how-it-works/"
+
+[[menu.docs]]
+  name = "Usage"
+  weight = 3
+  url = "/usage/"
+
+[[menu.docs]]
+  name = "Arguments"
+  weight = 4
+  url = "/arguments/"
+
+[imaging]
+  resampleFilter = "CatmullRom"
+  quality = 75
+  anchor = "smart"
diff --git a/docs/documentation/how-it-works.md → docs/how-it-works.md b/docs/documentation/how-it-works.md → docs/how-it-works.md
@@ -1,3 +1,17 @@
+---
+title: How Gitfs works
+linktitle: Gitfs explained
+description: Gitfs uses fuse to create current and history directories
+categories: [gitfs]
+keywords: [gitfs, readonlyview, passthroughview, currentview, historyview, commitview, indexview, fetchworker, mergeworker]
+weight: 2
+draft: false
+aliases: []
+toc: true
+related: true
+slug: how-gitfs-works
+---
+
 ## FUSE
 
 gitfs uses [FUSE](http://fuse.sourceforge.net/) to create its filesystem. It’s used to create the `current` and `history` directories that you can find where you mounted the repository. More on that [here](usage.md#user-content-directory-structure).

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
diff --git a/docs/documentation/usage.md → docs/usage.md b/docs/documentation/usage.md → docs/usage.md
@@ -1,6 +1,20 @@
+---
+title: How to install and use Gitfs
+linktitle: Install Gitfs
+description: Here are the required steps to install and use Gitfs on your machine.
+categories: [gitfs]
+keywords: [gitfs, install gitfs, install on ubuntu 18.04, install on ubuntu 19.04, gitfs on ubuntu, gitfs on debian, gitfs on macos]
+weight: 3
+draft: false
+aliases: []
+toc: true
+related: true
+slug: install-and-use-gitfs
+---
+
 ## Installing
 
-1. Ubuntu 12.04 and 14.04 are fully supported for now.
+1. Ubuntu 18.04, 19.04 and 19.10 are fully supported for now.
 
 ```
 sudo add-apt-repository ppa:presslabs/gitfs

diff --git a/docs/documentation/index.md → docs/what-is-gitfs.md b/docs/documentation/index.md → docs/what-is-gitfs.md
@@ -1,3 +1,17 @@
+---
+title: What is Gitfs
+linktitle: What is Gitfs
+description: Gitfs is a fuse file system that fully integrates with git
+categories: [gitfs]
+keywords: [gitfs, versioned filesystem, git filesystem, linux filesystem, macos filesystem]
+weight: 1
+draft: false
+aliases: []
+toc: true
+related: true
+slug: what-is-gitfs
+---
+
 ## Welcome to gitfs
 
 gitfs is a [FUSE](http://fuse.sourceforge.net/) file system that fully integrates with git. You can mount a remote repository’s branch locally, and any subsequent changes made to the files will be automatically committed to the remote.