Skip to content
This repository has been archived by the owner on Sep 17, 2022. It is now read-only.

Commit

Permalink
This is a quick and dirty poc for the docsy them
Browse files Browse the repository at this point in the history
Notes:
- No dark mode
- Ability to create page specific issues
- Directly edit content and issue PRs
- Multiple language support
  • Loading branch information
nickelskevin committed May 17, 2021
1 parent bb158ac commit 6e47719
Show file tree
Hide file tree
Showing 41 changed files with 21,236 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .gitignore
@@ -1 +1,2 @@
public/
public/
.DS_Store
6 changes: 6 additions & 0 deletions .gitmodules
@@ -0,0 +1,6 @@
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/google/docsy.git
[submodule "themes/doks"]
path = themes/doks
url = https://github.com/h-enk/doks-child-theme.git
1 change: 1 addition & 0 deletions assets/icons/logo.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions assets/scss/_variables_project.scss
@@ -0,0 +1,6 @@
/*
Add styles or override variables from the theme here.
*/

261 changes: 258 additions & 3 deletions config.toml
@@ -1,3 +1,258 @@
baseURL = "http://example.org/"
languageCode = "en-us"
title = "My New Hugo Site"
baseURL = "/"
title = "@platform - creating a network of trust"

enableRobotsTXT = true

# Hugo allows theme composition (and inheritance). The precedence is from left to right.
theme = ["docsy"]

# Will give values to .Lastmod etc.
enableGitInfo = true

# Language settings
contentDir = "content/en"
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = false
# Useful when translating.
enableMissingTranslationPlaceholders = true

disableKinds = ["taxonomy", "taxonomyTerm"]

# 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 = "tango"

# Configure how URLs look like per section.
[permalinks]
blog = "/:section/:year/:month/:day/:slug/"

## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
[blackfriday]
plainIDAnchors = true
hrefTargetBlank = true
angledQuotes = false
latexDashes = true

# 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"

# Language configuration

[languages]
[languages.en]
title = "the @platform"
description = "@platform docs"
languageName ="English"
# Weight used for sorting.
weight = 1
[languages.no]
title = "the @plattform"
description = "Hjelp ønsket"
languageName ="Norsk"
contentDir = "content/no"
time_format_default = "02.01.2006"
time_format_blog = "02.01.2006"

[languages.sp]
title = "the @plataforma"
description = "Se busca ayudante"
languageName ="Spanish"
contentDir = "content/sp"
time_format_default = "02.01.2006"
time_format_blog = "02.01.2006"

# [languages.fa]
# title = "اسناد گلدی"
# description = "یک نمونه برای پوسته داکسی"
# languageName ="فارسی"
# contentDir = "content/fa"
# time_format_default = "2006.01.02"
# time_format_blog = "2006.01.02"

[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
style = "tango"
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax = "true"

# Everything below this are Site Params

# Comment out if you don't want the "print entire section" link enabled.
[outputs]
section = ["HTML", "print"]

[params]
copyright = "The @ Company"
privacy_policy = "https://atsign.com/privacy-policy"

# First one is picked as the Twitter card image if not set on page.
# images = ["images/project-illustration.png"]

# Menu title if your navbar has a versions selector to access old versions of your site.
# This menu appears only if you have at least one [params.versions] set.
version_menu = "Releases"

# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version = false

# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
version = "0.0"

# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version = "https://example.com"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/atsign-foundation/atsign.dev"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/orgs/atsign-foundation/projects/5"

# Specify a value here if your content directory is not in your repo's root directory
# github_subdir = ""

# Uncomment this if you have a newer GitHub repo with "main" as the default branch,
# or specify a new value if you want to reference another branch in your GitHub links
# github_branch= "main"

# Google Custom Search Engine ID. Remove or comment out to disable search.
# gcs_engine_id = "d72aa9b2712488cc3"

# Enable Algolia DocSearch
algolia_docsearch = false

# Enable Lunr.js offline search
offlineSearch = false

# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting = false

# User interface configuration
[params.ui]
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact = false
# Set to true to disable breadcrumb navigation.
breadcrumb_disable = false
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable = false
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
navbar_logo = true
# Set to true to disable the About link in the site footer
footer_about_disable = true

# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
# add "hide_feedback: true" to the page's front matter.
[params.ui.feedback]
enable = true
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'

# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# add "hide_readingtime: true" to the page's front matter
[params.ui.readingtime]
enable = false

[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
# [[params.links.user]]
# name = "Mailing list"
# url = "https://example.org/mail"
# icon = "fa fa-envelope"
# desc = "Discussion and help from your fellow users"
[[params.links.user]]
name = "YouTube"
url = "https://www.youtube.com/channel/UCzjSJbPmIEDXFbHb2RIj9Gg"
icon = "fab fa-youtube"
desc = "Lots of good stuff on our YouTube video channel"
[[params.links.user]]
name ="LinkedIn"
url = "https://linkedin.com/company/atsigncompany"
icon = "fab fa-linkedin"
desc = "Follow our interesting posts on LinkedIn!"
[[params.links.user]]
name = "Medium"
url = "https://atsigncompany.medium.com"
icon = "fab fa-medium"
desc = "Read our more in depth articles on Medium"
[[params.links.user]]
name ="Twitter"
url = "https://twitter.com/atsigncompany"
icon = "fab fa-twitter"
desc = "Follow us on Twitter to get the latest news!"
[[params.links.user]]
name ="Facebook"
url = "https://facebook.com/atsigncompany"
icon = "fab fa-facebook"
desc = "Join us on Facebook find out what's happening!"
[[params.links.user]]
name = "Instagram"
url = "https://instagram.com/atsigncompany"
icon = "fab fa-instagram"
desc = "See our posts on Instagram"
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
[[params.links.developer]]
name = "GitHub"
url = "https://github.com/atsign-foundation"
icon = "fab fa-github"
desc = "Development takes place here!"
[[params.links.developer]]
name = "Discord"
url = "https://discord.gg/55sHTQFxfz"
icon = "fab fa-discord"
desc = "Hangout with the core teram and other developers"
[[params.links.developer]]
name = "Hashnode"
url = "https://blog.atsign.dev/"
icon = "fab fa-hashnode"
desc = "Short technical articles about specific topics"
[[params.links.developer]]
name = "Reddit"
url = "https://www.reddit.com/r/EctoGammat"
icon = "fab fa-reddit"
desc = "Join the conversation on our subreddit"
[[params.links.developer]]
name = "Developer email group"
url = "https://groups.google.com/a/atsign.com/g/dev"
icon = "fa fa-envelope"
desc = "Get updates and discuss issues around the project"
[[params.links.developer]]
name = "Meetup"
url = "https://www.meetup.com/Ektogamant-Open-Source-Developers-for-Internet-Optimism"
icon = "fab fa-meetup"
desc = "Ecto Gammat: Open Source Developers for Internet Optimism"

# Doks theme experiment
baseurl = "/"
canonifyURLs = false
disableAliases = true
disableHugoGeneratorInject = true
enableEmoji = true
enableGitInfo = false
enableRobotsTXT = true
languageCode = "en-US"
paginate = 7
rssLimit = 10
81 changes: 81 additions & 0 deletions content/en/_index.html
@@ -0,0 +1,81 @@
+++
title = "@developer"
linkTitle = "@developer"

+++

{{< blocks/cover title="Welcome to the @platform developer site!" image_anchor="top" height="full" color="orange" >}}
<div class="mx-auto">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<!-- <a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/google/docsy-example">
Download <i class="fab fa-github ml-2 "></i>
</a> -->
<p class="lead mt-5">Build the next generation of privacy-first apps with the @platform!</p>
{{< blocks/link-down color="info" >}}
</div>
{{< /blocks/cover >}}


{{% blocks/lead color="primary" %}}
Build the next generation of privacy-first apps with the @platform.

Our free, open source, permissions-based platform gives people control over their own data.
{{% /blocks/lead %}}

{{< blocks/section color="dark" >}}
{{% blocks/feature icon="fa-lightbulb" title="All you need is on pub.dev!" %}}
Check out our Dart and Flutter packages on pob.dev.

Please follow this space for updates!
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}}
We do a [Pull Request](https://github.com/google/docsy-example/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}
For announcement of latest features etc.
{{% /blocks/feature %}}


{{< /blocks/section >}}


{{< blocks/section >}}
<div class="col">
<h1 class="text-center">This is the second Section</h1>
</div>

{{< /blocks/section >}}



{{< blocks/section >}}
{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}}
Get the Goldydocs app!
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}}
We do a [Pull Request](https://github.com/google/docsy-example/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/GoHugoIO" %}}
For announcement of latest features etc.
{{% /blocks/feature %}}


{{< /blocks/section >}}

{{< blocks/section >}}

<div class="col-12">
<h1 class="text-center">This is another Section</h1>
</div>

{{< /blocks/section >}}

0 comments on commit 6e47719

Please sign in to comment.