Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 64 additions & 5 deletions config.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
baseURL = 'https://docs.nephio.org/'
languageCode = 'en-us'
title = 'Nephio Documentation'

# based on https://www.docsy.dev/docs/get-started/docsy-as-module/start-from-scratch/

# Language settings

contentDir = "content/en"
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = false
Expand All @@ -12,8 +14,10 @@ enableMissingTranslationPlaceholders = true

[module]
proxy = "direct"

# uncomment line below for temporary local development of module
# replacements = "github.com/google/docsy -> ../../docsy"

[module.hugoVersion]
extended = true
min = "0.73.0"
Expand All @@ -25,99 +29,149 @@ enableMissingTranslationPlaceholders = true
disable = false

[markup]

# Changing the depth of levels displayed in the right side page navigation menu
# from: https://gohugo.io/methods/page/tableofcontents/

[markup.tableOfContents]

endLevel = 5
ordered = true
startLevel = 2


[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

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

prism_syntax_highlighting = true

[params]

copyright = "The Nephio Authors"

#privacy_policy = ""

code_of_conduct = "https://lfprojects.org/policies/code-of-conduct/"

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

version = "main"

# 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://docs.nephio.org/docs/"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)

github_repo = "https://github.com/nephio-project/docs"

# An optional link to a related project repo. For example, the sibling repository where your product code lives.
#github_project_repo = "https://github.com/nephio-project/nephio"

github_project_repo = "https://github.com/nephio-project/nephio"

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

#github_subdir = ""

time_format_blog = "Monday, January 02, 2006"
time_format_default = "January 2, 2006"

# Sections to publish in the main RSS feed.

rss_sections = ["blog"]

# Google Custom Search Engine ID. Remove or comment out to disable search.

#gcs_engine_id = ""

# Enable Algolia DocSearch
algolia_docsearch = false

params.search.algolia = false

#Enable offline search with Lunr.js

offlineSearch = false
offlineSearchSummaryLength = 70
offlineSearchMaxResults = 10

# User interface configuration

[params.ui]

# Enable to show the side bar menu in its compact state.

sidebar_menu_compact = true

# With the compact menu (.ui.sidebar_menu_compact = true), only the current page’s ancestors, siblings and direct
# descendants are shown. You can use the optional parameter .ui.ul_show to set a desired menu depth to always be
# visible. For example, with .ui.ul_show = 1 the first menu level is always displayed.
# from: https://www.docsy.dev/docs/adding-content/navigation/

ul_show = 1

# 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

# 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

enable = false

# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
# Update with your own repository and response text.

yes = 'Glad to hear it! Please <a href="https://github.com/nephio-project/nephio/issues/new">tell us how we can improve</a>.'
no = 'Sorry to hear that. Please <a href="https://github.com/nephio-project/nephio/issuesnew">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 = "User mailing list"
Expand All @@ -135,12 +189,16 @@ enable = false
# icon = "fab fa-stack-overflow"
# desc = "Practical questions and curated answers"
# 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/nephio-project/nephio"
icon = "fab fa-github"
desc = "Development takes place here!"
desc = "Development takes place here!"

# [[params.links.developer]]

# name = "Slack"
# url = "https://example.org/slack"
# icon = "fab fa-slack"
Expand All @@ -152,6 +210,7 @@ enable = false
# desc = "Discuss development issues around the project"

# Add your release versions here

[[params.versions]]
version = "main"
url = "https://docs.nephio.org/docs/"
Expand Down