From 63a60ccf7e3fe494b46d9ab75c15d355b7257404 Mon Sep 17 00:00:00 2001 From: Steve Manuel Date: Sun, 21 Jan 2018 12:21:40 -0700 Subject: [docs] bump version, release docs version (#226) * [docs] README.md: update with circle badge and fix docs * [docs] bump version --- docs/build/index.html | 2 +- docs/build/mkdocs/search_index.json | 4 ++-- docs/build/sitemap.xml | 44 ++++++++++++++++++------------------- docs/mkdocs.yml | 27 +++++++++++++++++++++++ docs/src/CLI/General-Usage.md | 1 + docs/src/Quickstart/Overview.md | 2 +- docs/src/index.md | 2 +- 7 files changed, 55 insertions(+), 27 deletions(-) create mode 100644 docs/mkdocs.yml (limited to 'docs') diff --git a/docs/build/index.html b/docs/build/index.html index ca66f10..57be212 100644 --- a/docs/build/index.html +++ b/docs/build/index.html @@ -862,7 +862,7 @@ content editors, and a fast HTTP API on which to build modern applications.

  • File an issue
    • -

    current version: v0.9.3 @ ponzu:master

    +

    current version: v0.9.4 @ ponzu:master

    diff --git a/docs/build/mkdocs/search_index.json b/docs/build/mkdocs/search_index.json index 66eec53..bf2f349 100644 --- a/docs/build/mkdocs/search_index.json +++ b/docs/build/mkdocs/search_index.json @@ -2,7 +2,7 @@ "docs": [ { "location": "/", - "text": "Ponzu CMS + Server Framework Docs\n\n\n\n\nWhat is Ponzu?\n\n\n\n\nWatch the \nvideo introduction\n\n\n\n\nPonzu is a powerful and efficient open-source HTTP server framework and CMS. It \nprovides automatic, free, and secure HTTP/2 over TLS (certificates obtained via \n\nLet's Encrypt\n), a useful CMS and scaffolding to generate \ncontent editors, and a fast HTTP API on which to build modern applications.\n\n\nWant to jump in right away? Try the \nQuickstart\n\n\nTable of Contents\n\n\n\n\nCLI\n\n\nContent\n\n\nForm Fields\n\n\nHTTP API - Content\n\n\nHTTP API - File Metadata\n\n\nHTTP API - Search\n\n\nInterfaces - API\n\n\nInterfaces - Editor\n\n\nInterfaces - Item\n\n\nInterfaces - Search\n\n\nCreating Ponzu Addons\n\n\nUsing Ponzu Addons\n\n\nQuickstart\n\n\nBackups\n\n\nSystem Configuration\n\n\n\n\nNeed help? Get in touch\n\n\n\n\nChat: \n#ponzu on Slack\n\n\nReach out on Twitter: \n@ponzu_cms\n\n\nFile an \nissue\n\n\n\n\n\n\ncurrent version: \nv0.9.3\n @ ponzu:master", + "text": "Ponzu CMS + Server Framework Docs\n\n\n\n\nWhat is Ponzu?\n\n\n\n\nWatch the \nvideo introduction\n\n\n\n\nPonzu is a powerful and efficient open-source HTTP server framework and CMS. It \nprovides automatic, free, and secure HTTP/2 over TLS (certificates obtained via \n\nLet's Encrypt\n), a useful CMS and scaffolding to generate \ncontent editors, and a fast HTTP API on which to build modern applications.\n\n\nWant to jump in right away? Try the \nQuickstart\n\n\nTable of Contents\n\n\n\n\nCLI\n\n\nContent\n\n\nForm Fields\n\n\nHTTP API - Content\n\n\nHTTP API - File Metadata\n\n\nHTTP API - Search\n\n\nInterfaces - API\n\n\nInterfaces - Editor\n\n\nInterfaces - Item\n\n\nInterfaces - Search\n\n\nCreating Ponzu Addons\n\n\nUsing Ponzu Addons\n\n\nQuickstart\n\n\nBackups\n\n\nSystem Configuration\n\n\n\n\nNeed help? Get in touch\n\n\n\n\nChat: \n#ponzu on Slack\n\n\nReach out on Twitter: \n@ponzu_cms\n\n\nFile an \nissue\n\n\n\n\n\n\ncurrent version: \nv0.9.4\n @ ponzu:master", "title": "Home" }, { @@ -22,7 +22,7 @@ }, { "location": "/#need-help-get-in-touch", - "text": "Chat: #ponzu on Slack Reach out on Twitter: @ponzu_cms File an issue current version: v0.9.3 @ ponzu:master", + "text": "Chat: #ponzu on Slack Reach out on Twitter: @ponzu_cms File an issue current version: v0.9.4 @ ponzu:master", "title": "Need help? Get in touch" }, { diff --git a/docs/build/sitemap.xml b/docs/build/sitemap.xml index fe5a0a7..0002953 100644 --- a/docs/build/sitemap.xml +++ b/docs/build/sitemap.xml @@ -4,7 +4,7 @@ / - 2017-09-01 + 2018-01-21 daily @@ -13,13 +13,13 @@ /CLI/General-Usage/ - 2017-09-01 + 2018-01-21 daily /CLI/Generating-References/ - 2017-09-01 + 2018-01-21 daily @@ -29,13 +29,13 @@ /Content/An-Overview/ - 2017-09-01 + 2018-01-21 daily /Content/Extending-Content/ - 2017-09-01 + 2018-01-21 daily @@ -45,7 +45,7 @@ /Form-Fields/HTML-Inputs/ - 2017-09-01 + 2018-01-21 daily @@ -55,19 +55,19 @@ /HTTP-APIs/Content/ - 2017-09-01 + 2018-01-21 daily /HTTP-APIs/File-Metadata/ - 2017-09-01 + 2018-01-21 daily /HTTP-APIs/Search/ - 2017-09-01 + 2018-01-21 daily @@ -77,31 +77,31 @@ /Interfaces/API/ - 2017-09-01 + 2018-01-21 daily /Interfaces/Editor/ - 2017-09-01 + 2018-01-21 daily /Interfaces/Format/ - 2017-09-01 + 2018-01-21 daily /Interfaces/Item/ - 2017-09-01 + 2018-01-21 daily /Interfaces/Search/ - 2017-09-01 + 2018-01-21 daily @@ -111,13 +111,13 @@ /Ponzu-Addons/Creating-Addons/ - 2017-09-01 + 2018-01-21 daily /Ponzu-Addons/Using-Addons/ - 2017-09-01 + 2018-01-21 daily @@ -127,7 +127,7 @@ /Quickstart/Overview/ - 2017-09-01 + 2018-01-21 daily @@ -137,7 +137,7 @@ /References/Overview/ - 2017-09-01 + 2018-01-21 daily @@ -147,7 +147,7 @@ /Running-Backups/Backups/ - 2017-09-01 + 2018-01-21 daily @@ -157,7 +157,7 @@ /System-Configuration/Settings/ - 2017-09-01 + 2018-01-21 daily @@ -167,13 +167,13 @@ /System-Deployment/Docker/ - 2017-09-01 + 2018-01-21 daily /System-Deployment/SysV-Style/ - 2017-09-01 + 2018-01-21 daily diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..71f0cb5 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,27 @@ +theme: material +site_name: Ponzu +docs_dir: src +site_dir: build +repo_name: ponzu-cms/ponzu +repo_url: https://github.com/ponzu-cms/ponzu + +markdown_extensions: + - codehilite(linenums=false) + - meta + - admonition + - toc(permalink=true) + +google_analytics: + - 'UA-98609560-1' + - auto + +extra: + palette: + primary: grey + accent: light-blue + social: + - type: github + link: https://github.com/ponzu-cms + - type: twitter + link: https://twitter.com/ponzu_cms + logo: images/logo.png diff --git a/docs/src/CLI/General-Usage.md b/docs/src/CLI/General-Usage.md index 2928a53..993ff18 100644 --- a/docs/src/CLI/General-Usage.md +++ b/docs/src/CLI/General-Usage.md @@ -46,6 +46,7 @@ type Review struct { Title string `json:"title"` Body string `json:"body"` Rating int `json:"rating"` + Tags []string `json:"tags"` } ``` diff --git a/docs/src/Quickstart/Overview.md b/docs/src/Quickstart/Overview.md index 329a0f7..6c4bec5 100644 --- a/docs/src/Quickstart/Overview.md +++ b/docs/src/Quickstart/Overview.md @@ -18,7 +18,7 @@ $ cd $GOPATH/src/github.com/nilslice/reviews 5) Generate content type file and boilerplate code (creates `content/review.go`): ```bash -$ ponzu generate content review title:"string" author:"string" rating:"float64" body:"string":richtext website_url:"string" items:"[]string" photo:string:file +$ ponzu generate content review title:"string" author:"string" rating:"float64" body:"string":richtext website_url:"string" items:"[]string" photo:string:file` ``` 6) Build your project: diff --git a/docs/src/index.md b/docs/src/index.md index f9c7ccc..bdf2ddf 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -38,4 +38,4 @@ Want to jump in right away? Try the [Quickstart](/Quickstart/Overview) - File an [issue](https://github.com/ponzu-cms/ponzu/issues) --- -current version: `v0.9.3` @ ponzu:master +current version: `v0.9.4` @ ponzu:master -- cgit v1.2.3