Skip to content

Commit 2bc4b15

Browse files
vtemianvtemian
committed
Migrate docs to the new format
1 parent bf375a0 commit 2bc4b15

File tree

8 files changed

+159
-25
lines changed

8 files changed

+159
-25
lines changed

‎docs/Makefile

Whitespace-only changes.

‎docs/_index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: What is Gitfs
3+
linktitle: What is Gitfs
4+
description: Gitfs is a fuse file system that fully integrates with git
5+
categories: [gitfs]
6+
keywords: [gitfs, versioned filesystem, git filesystem, fuse, linux filesystem, macos filesystem]
7+
toc: false
8+
related: false
9+
layout: documentation-home
10+
---

‎docs/documentation/arguments.md renamed to ‎docs/arguments.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
---
2+
title: Arguments
3+
linktitle: Arguments
4+
description: A list with all arguments for Gitfs
5+
categories: [gitfs]
6+
keywords: [gitfs, arguments, usage]
7+
weight: 4
8+
draft: false
9+
aliases: []
10+
toc: true
11+
related: true
12+
slug: arguments
13+
---
14+
115
## Using options
216

317
In order to use options when mounting gitfs, you need to append the options as an argument when using the mount command like this:

‎docs/config.toml

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
baseURL = "https://www.presslabs.com/code/gitfs/"
2+
languageCode = "en-us"
3+
title = "Gitfs DOCS"
4+
summaryLength = 15
5+
metaDataFormat = "yaml"
6+
theme = "docs"
7+
enableRobotsTXT = true
8+
enableGitInfo = true
9+
pygmentsCodeFences = true
10+
pygmentsOptions = ""
11+
pygmentsUseClasses = true
12+
pygmentsUseClassic = false
13+
pygmentsStyle = "github"
14+
dataDir = "/site/data"
15+
16+
[params]
17+
site_url = "https://www.presslabs.com/code/"
18+
legal_url = "https://www.presslabs.com/legal"
19+
breadcrumbs_root = "Gitfs DOCS"
20+
quick_start = true
21+
quick_start_link = "what-is-gitfs/"
22+
logo_text = "CODE"
23+
search_placeholder = "Search code"
24+
footer_menu = true
25+
footer_menu_title = "DOCUMENTATION"
26+
title = "Welcome to Gitfs Documentation!"
27+
description = "Gitfs is a fuse filesystem that fully integrates with git"
28+
release = "0.5.1"
29+
# debug = true
30+
algolia_search = true
31+
algolia_appId = "0TS6NFHDBC"
32+
algolia_apiKey = "099bffdf3b4a6ea94ddbea10f73dd15a"
33+
algolia_indexName = "Gitfs Docs"
34+
algolia_currentLanguageOnly = true
35+
images = ["images/code.jpg"]
36+
37+
[params.algolia]
38+
vars = ["title", "description", "summary", "content", "date", "lastmod", "permalink", "text", "lvl0", "lvl1", "url"]
39+
params = ["categories", "keywords"]
40+
41+
[blackfriday]
42+
angledQuotes = true
43+
extensions = ["hardLineBreak"]
44+
sourceRelativeLinks = true
45+
fractions = false
46+
plainIDAnchors = true
47+
48+
[outputFormats.Algolia]
49+
baseName = "algolia"
50+
isPlainText = true
51+
mediaType = "application/json"
52+
notAlternative = true
53+
54+
[outputs]
55+
home = [ "HTML", "RSS", "JSON", "Algolia" ]
56+
57+
[taxonomies]
58+
category = "categories"
59+
60+
[related]
61+
threshold = 80
62+
includeNewer = true
63+
toLower = false
64+
65+
[[related.indices]]
66+
name = "keywords"
67+
weight = 150
68+
69+
[[menu.docs]]
70+
name = "What is Gitfs"
71+
weight = 1
72+
url = "/what-is-gitfs/"
73+
74+
[[menu.docs]]
75+
name = "How it works"
76+
weight = 2
77+
url = "/how-it-works/"
78+
79+
[[menu.docs]]
80+
name = "Usage"
81+
weight = 3
82+
url = "/usage/"
83+
84+
[[menu.docs]]
85+
name = "Arguments"
86+
weight = 4
87+
url = "/arguments/"
88+
89+
[imaging]
90+
resampleFilter = "CatmullRom"
91+
quality = 75
92+
anchor = "smart"

‎docs/documentation/how-it-works.md renamed to ‎docs/how-it-works.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
---
2+
title: How Gitfs works
3+
linktitle: Gitfs explained
4+
description: Gitfs uses fuse to create current and history directories
5+
categories: [gitfs]
6+
keywords: [gitfs, readonlyview, passthroughview, currentview, historyview, commitview, indexview, fetchworker, mergeworker]
7+
weight: 2
8+
draft: false
9+
aliases: []
10+
toc: true
11+
related: true
12+
slug: how-gitfs-works
13+
---
14+
115
## FUSE
216

317
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).

‎docs/mkdocs.yml

-24
This file was deleted.

‎docs/documentation/usage.md renamed to ‎docs/usage.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
1+
---
2+
title: How to install and use Gitfs
3+
linktitle: Install Gitfs
4+
description: Here are the required steps to install and use Gitfs on your machine.
5+
categories: [gitfs]
6+
keywords: [gitfs, install gitfs, install on ubuntu 18.04, install on ubuntu 19.04, gitfs on ubuntu, gitfs on debian, gitfs on macos]
7+
weight: 3
8+
draft: false
9+
aliases: []
10+
toc: true
11+
related: true
12+
slug: install-and-use-gitfs
13+
---
14+
115
## Installing
216

3-
1. Ubuntu 12.04 and 14.04 are fully supported for now.
17+
1. Ubuntu 18.04, 19.04 and 19.10 are fully supported for now.
418

519
```
620
sudo add-apt-repository ppa:presslabs/gitfs

‎docs/documentation/index.md renamed to ‎docs/what-is-gitfs.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
---
2+
title: What is Gitfs
3+
linktitle: What is Gitfs
4+
description: Gitfs is a fuse file system that fully integrates with git
5+
categories: [gitfs]
6+
keywords: [gitfs, versioned filesystem, git filesystem, linux filesystem, macos filesystem]
7+
weight: 1
8+
draft: false
9+
aliases: []
10+
toc: true
11+
related: true
12+
slug: what-is-gitfs
13+
---
14+
115
## Welcome to gitfs
216

317
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.

0 commit comments

Comments
 (0)