Skip to content

Commit

Permalink
[WIP][docs] Add hugo theme
Browse files Browse the repository at this point in the history
new format

hugo updates

updated docs format in hugo

updated outline

content trasferred to hugo site

initial formatting done

edits to operator section

remove folder

Update config

Testing content

Add theme as submodule

Change submodule path

Remove rogue submodule

Add netlify config for this preview branch

Miss-formed YAML broke build

Update publish path

Add hugo publish dir to gitignore
  • Loading branch information
benraskin92 authored and ChrisChinchilla committed Aug 20, 2020
1 parent bf81308 commit 16ad955
Show file tree
Hide file tree
Showing 137 changed files with 4,921 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,5 @@ m3db.io/openapi
# Vagrant
.vagrant

#docs ignores
docs-beta/public
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[submodule ".ci"]
path = .ci
url = https://github.com/m3db/ci-scripts.git
[submodule "docs-beta/themes/docs-theme"]
path = docs-beta/themes/docs-theme
url = https://github.com/chronosphereio/docs-theme.git
6 changes: 6 additions & 0 deletions docs-beta/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

117 changes: 117 additions & 0 deletions docs-beta/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# Change the default theme to be use when building the site with Hugo
theme = "docs-theme"

baseURL = "/"
languageCode = "en-US"
defaultContentLanguage = "en"

title = "M3DB Documentation"
metaDataFormat = "yaml"
defaultContentLanguageInSubdir= true

# Highlighting config.
pygmentsCodeFences = true
pygmentsUseClasses = false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic = false
#pygmentsOptions = "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle = "vs"

enableGitInfo = true

[frontmatter]
# date = ["date", ":filename", "publishDate", "lastmod"]

# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

[services]
[services.googleAnalytics]
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
# id = "UA-00000000-0"

#fullversion = "v1.18.0"
#version = "v1.18"
githubbranch = "master"
docsbranch = "master"
deprecated = false
#currentUrl = "https://kubernetes.io/docs/home/"
#nextUrl = "https://kubernetes-io-vnext-staging.netlify.com/"
githubWebsiteRepo = "https://github.com/m3db/m3"
githubWebsiteRaw = "raw.githubusercontent.com/m3db/m3"

# Enable Algolia DocSearch
# algolia_docsearch = false

# Enable Lunr.js offline search
offlineSearch = false

[params]
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
# Useful to give opportunity to people to create merge request for your doc.
# See the config.toml file from this documentation site to have an example.
editURL = "https://github.com/m3db/m3"
# Author of the site, will be used in meta information
author = "m3"
# Description of the site, will be used in meta information
description = "m3documentation"
# Shows a checkmark for visited pages on the menu
showVisitedLinks = false
# Disable search function. It will hide search bar
disableSearch = false
# Javascript and CSS cache are automatically busted when new version of site is generated.
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
disableAssetsBusting = false
# Set this to true to disable copy-to-clipboard button for inline code.
disableInlineCopyToClipBoard = false
# A title for shortcuts in menu is set by default. Set this to true to disable it.
disableShortcutsTitle = false
# When using mulitlingual website, disable the switch language button.
disableLanguageSwitchingButton = false
# Hide breadcrumbs in the header and only show the current page title
disableBreadcrumb = true
# Hide Next and Previous page buttons normally displayed full height beside content
disableNextPrev = true
# Order sections in menu by "weight" or "title". Default to "weight"
ordersectionsby = "weight"
# Change default color scheme with a variant one. Can be "red", "blue", "green".
themeVariant = ""
twitter = "m3db_io"

# TODO: Do not like doing this really
[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.goldmark.parser]
attribute = true
autoHeadingID = true
autoHeadingIDType = "github"
[markup.tableOfContents]
endLevel = 3
ordered = false
startLevel = 2
[markup.goldmark.extensions]
definitionList = true
footnote = true
linkify = true
strikethrough = true
table = true
taskList = true
typographer = true

[[Languages.en.menu.shortcuts]]
name = "<i class='fab fa-fw fa-github'></i> GitHub"
identifier = "ds"
url = "https://github.com/m3db/m3"
weight = 10

[outputs]
home = [ "HTML", "RSS", "JSON"]
page = [ "HTML"]
section = [ "HTML"]
chapter = [ "HTML"]
42 changes: 42 additions & 0 deletions docs-beta/content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
+++
title = "Home"
date = 2020-04-01T19:26:56-04:00
weight = 4
chapter = false
+++

{{< tabs name="tab_with_md" >}}
{{% tab name="Markdown" %}}
This is **some markdown.**
```bash
code
```
{{% /tab %}}
{{< tab name="HTML" >}}

HTML

{{< /tab >}}
{{< tab name="JSON" >}}

Include code from elsewhere.

{{% codeinclude file="/static/podtemplate.json" language="json" %}}

{{< /tab >}}
{{< /tabs >}}

{{< glossary_tooltip text="test" term_id="test" >}}

```go {hl_lines=[2]}
func GetTitleFunc(style string) func(s string) string {
switch strings.ToLower(style) {
case "go":
return strings.Title
case "chicago":
return transform.NewTitleConverter(transform.ChicagoStyle)
default:
return transform.NewTitleConverter(transform.APStyle)
}

```
15 changes: 15 additions & 0 deletions docs-beta/content/about_m3/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
+++
title = "About the project"
date = 2020-04-01T19:43:46-04:00
weight = 2
chapter = true
pre = "<b>2. </b>"
+++

### About M3

#### Contributing to the Project
#### Glossary
#### Release notes


Loading

0 comments on commit 16ad955

Please sign in to comment.