-
Notifications
You must be signed in to change notification settings - Fork 51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Docsy #244
Update Docsy #244
Changes from all commits
273de37
2520893
77c64d7
3df1322
234a95f
70a0e69
6d868fb
3b4f6ed
6807e6f
6f79046
1955b65
d4d8d0f
1edf28a
bc536ab
102dc94
911cf76
8ba7e0d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,35 @@ | ||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: | ||
// https://github.com/microsoft/vscode-dev-containers/tree/v0.217.4/containers/hugo | ||
{ | ||
"name": "Hugo (Community)", | ||
"name": "Hugo", | ||
"build": { | ||
"dockerfile": "Dockerfile", | ||
"args": { | ||
// Update VARIANT to pick hugo variant. | ||
// Example variants: hugo, hugo_extended | ||
// Rebuild the container if it already exists to update. | ||
"VARIANT": "hugo_extended", | ||
// Update VERSION to pick a specific hugo version. | ||
// Example versions: latest, 0.73.0, 0,71.1 | ||
// Rebuild the container if it already exists to update. | ||
"VERSION": "latest", | ||
// Update NODE_VERSION to pick the Node.js version: 12, 14 | ||
"NODE_VERSION": "14", | ||
} | ||
"dockerfile": "Dockerfile" | ||
}, | ||
// Set *default* container specific settings.json values on container create. | ||
"settings": { | ||
"html.format.templating": true, | ||
"customizations": { | ||
"vscode": { | ||
// Set *default* container specific settings.json values on container create. | ||
"settings": { | ||
"html.format.templating": true | ||
}, | ||
// Add the IDs of extensions you want installed when the container is created. | ||
"extensions": [ | ||
"bungcip.better-toml", | ||
"davidanson.vscode-markdownlint", | ||
"GitHub.vscode-pull-request-github" | ||
] | ||
} | ||
}, | ||
// Add the IDs of extensions you want installed when the container is created. | ||
"extensions": [ | ||
"bungcip.better-toml", | ||
"davidanson.vscode-markdownlint", | ||
"GitHub.vscode-pull-request-github" | ||
], | ||
// Use 'forwardPorts' to make a list of ports inside the container available locally. | ||
"forwardPorts": [ | ||
1313 | ||
], | ||
"remoteUser": "vscode", | ||
// Use 'postCreateCommand' to run commands after the container is created. | ||
"postCreateCommand": "git submodule update --init --recursive --depth 1 && npm i", | ||
// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. | ||
"remoteUser": "node", | ||
// "postCreateCommand": "" | ||
"features": { | ||
"git": "os-provided" | ||
"ghcr.io/devcontainers/features/git:1": {}, | ||
"ghcr.io/devcontainers/features/go:1": {}, | ||
"ghcr.io/devcontainers/features/hugo:1": {}, | ||
"ghcr.io/devcontainers/features/node:1": {} | ||
} | ||
} | ||
} |
This file was deleted.
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -40,14 +40,7 @@ contact [[email protected]](mailto:[email protected]) with any additio | |
|
||
### Setup | ||
|
||
1. Clone and setup | ||
```sh | ||
# Clone all submodules | ||
git submodule update --init --recursive --depth 1 | ||
# Install NPM dependencies | ||
npm install | ||
``` | ||
2. Run Hugo server | ||
**Run Hugo server** | ||
``` | ||
$ hugo server | ||
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
module github.com/microsoft/alguidelines | ||
|
||
go 1.23.0 | ||
|
||
require github.com/google/docsy v0.10.0 // indirect |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
github.com/FortAwesome/Font-Awesome v0.0.0-20240402185447-c0f460dca7f7/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= | ||
github.com/google/docsy v0.10.0 h1:6tMDacPwAyRWNCfvsn/9qGOZDQ8b0aRzjRZvnZPY5dg= | ||
github.com/google/docsy v0.10.0/go.mod h1:c0nIAqmRTOuJ01F85U/wJPQtc3Zj9N58Kea9bOT2AJc= | ||
github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ languageCode = 'en-us' | |
title = 'AL Guidelines' | ||
|
||
# Hugo allows theme composition (and inheritance). The precedence is from left to right. | ||
theme = ["docsy"] | ||
theme = ["github.com/google/docsy"] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The sample does not specify a theme, but has the following content to use Docsy as a module (See https://www.docsy.dev/docs/get-started/docsy-as-module/) Sample config file:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In the migration guide, it was mentioned that the value can be changed from Alternatively, we could add the example you've provided. Should I adapt these changes? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
# Will give values to .Lastmod etc. | ||
enableGitInfo = true | ||
|
@@ -72,11 +72,12 @@ id = "" | |
|
||
[languages] | ||
[languages.en] | ||
description = "Guidelines for when Developing AL for Microsoft Dynamics 365 Business Central" | ||
languageName = "English" | ||
title = "alguidelines.dev - Business Central Design Patterns" | ||
languageName = "English" | ||
# Weight used for sorting. | ||
weight = 1 | ||
[languages.en.params] | ||
description = "Guidelines for when Developing AL for Microsoft Dynamics 365 Business Central" | ||
|
||
# Everything below this are Site Params | ||
|
||
|
@@ -149,8 +150,8 @@ url = '/blog/serverless-next.js-example-blog-with-fission/' | |
[params.ui] | ||
# Set to true to disable breadcrumb navigation. | ||
breadcrumb_disable = false | ||
# Set to true to disable the About link in the site footer | ||
footer_about_disable = false | ||
# Set to true to show an About link in the site footer | ||
footer_about_enable = true | ||
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar | ||
navbar_logo = true | ||
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sample file, has more content: (See https://github.com/google/docsy-example/blob/main/go.sum)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've followed the steps in https://www.docsy.dev/docs/updating/convert-site-to-module/#import-the-docsy-theme-module-as-a-dependency-of-your-site, which automatically generated the
go.sum
andgo.mod
files.Based on the commit history of the file, I assume they've added the additional docsy version dependencies to test the new RTL feature.
Would leave the content on it's initial, auto-generated state.