Skip to content

Commit

Permalink
Set up base meta docs site with Hugo (mdn#11200)
Browse files Browse the repository at this point in the history
* Add root Netlify config

* Add Netlify build configuration file

* Add initial meta site config

* Meta: print a prettier URL for development

* Add content scaffold

* Fix unresolved merge conflict in netlify.toml

* meta: Add submodule scripts to build/serve
  • Loading branch information
ddbeck authored Dec 15, 2021
1 parent 09dafad commit c22e857
Show file tree
Hide file tree
Showing 43 changed files with 2,016 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "meta/themes/docsy"]
path = meta/themes/docsy
url = https://github.com/google/docsy.git
4 changes: 4 additions & 0 deletions meta/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.hugo_build.lock
node_modules
public/
resources/
93 changes: 93 additions & 0 deletions meta/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
baseURL = "/"
title = "MDN Web Docs for Contributors"

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

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

disableKinds = ["taxonomy", "taxonomyTerm", "tags", "tag"]
[taxonomies]
# tag = 'tags'

# 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

[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

[languages]
[languages.en]
title = "MDN Web Docs for Contributors"
description = "Documentation for documenters"
languageName ="English"
weight = 1

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

[params]
copyright = "Mozilla and contributors"
privacy_policy = "https://www.mozilla.org/en-US/privacy/websites/"
github_repo = "https://github.com/mdn/content"
github_branch = "main"
prism_syntax_highlighting = false

# [[params.links.user]]
# name = "Stack Overflow"
# url = "https://example.org/stack"
# 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/google/docsy"
# icon = "fab fa-github"
# desc = "Development takes place here!"
# [[params.links.developer]]
# name = "Slack"
# url = "https://example.org/slack"
# icon = "fab fa-slack"
# desc = "Chat with other project developers"
# [[params.links.developer]]
# name = "Developer mailing list"
# url = "https://example.org/mail"
# icon = "fa fa-envelope"
# desc = "Discuss development issues around the project"
17 changes: 17 additions & 0 deletions meta/content/en/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "MDN Web Docs for Contributors"
linkTitle: "Home"
weight: 20
layout: docs
menu:
main:
weight: 20

# forces the whole site to use the "docs" structure in Docsy
cascade:
- type: "docs"
_target:
path: "/**"
---

If you want to contribute to MDN Web Docs, then you're in the right place. If you're looking for documentation for CSS, HTML, JavaScript, and other web development topics, go to [`developer.mozilla.org`](https://developer.mozilla.org/).
10 changes: 10 additions & 0 deletions meta/content/en/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Changelog"
weight: 100
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/community/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Community"
weight: 20
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/community/etiquette.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Etiquette and expectations for behavior"
weight: 30
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
12 changes: 12 additions & 0 deletions meta/content/en/community/fora.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Where to get help"
weight: 20
description: >
This page needs a description.
---

<!-- GitHub discussions, Matrix chat, Discourse -->

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
12 changes: 12 additions & 0 deletions meta/content/en/community/people.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Who makes MDN?"
weight: 10
description: >
This page needs a description.
---

<!-- Contributors, peers, owners… and you? -->

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
12 changes: 12 additions & 0 deletions meta/content/en/community/report-cpg-spam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Report spam and other community issues"
weight: 40
description: >
This page needs a description.
---

<!-- Need a process for this! -->

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
8 changes: 8 additions & 0 deletions meta/content/en/get-started/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
categories: ["Examples", "Placeholders"]
tags: ["test","docs"]
title: "Get started"
weight: 2
description: >
If you're a first-time contributor to MDN Web Docs, start here.
---
25 changes: 25 additions & 0 deletions meta/content/en/get-started/ways-to-contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Ways to contribute"
date: 2017-01-05
weight: 20
description: >
You can contribute in many ways, from reporting problems to writing docs to developing the platform.
---

<!--
- Create and improve docs
- Report issues
- Write and edit
- Review PRs
- Translate
- Participate in discussions and peer learning
- Develop the platform
- NEXT: learn about the community and
-->

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/get-started/why.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Why you should contribute to MDN"
weight: 10
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/governance/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Governance and process"
weight: 30
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/governance/issues/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Issues"
weight: 0
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/governance/issues/triage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Triage an issue"
weight: 0
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/governance/meetings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Meetings"
weight: 3
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/governance/pulls/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Pull requests"
weight: 0
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/governance/pulls/review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Review a pull request"
weight: 0
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/governance/roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "What we document"
weight: 2
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/governance/roles-and-responsibilities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Roles and responsibilities"
weight: 1
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
10 changes: 10 additions & 0 deletions meta/content/en/legacy/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Legacy documentation"
weight: 1000
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
6 changes: 6 additions & 0 deletions meta/content/en/related/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Related projects and resources"
weight: 100
description: >
More stuff that's useful.
---
5 changes: 5 additions & 0 deletions meta/content/en/related/browser-compat-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "@mdn/browser-compat-data"
description: >
Browser interoperability data that powers tables on MDN, caniuse, and more.
---
6 changes: 6 additions & 0 deletions meta/content/en/related/repositories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "All GitHub repositories"
weight: 1
description: >
A list of every MDN repository and what it's for.
---
5 changes: 5 additions & 0 deletions meta/content/en/related/specifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Web specifications"
description: >
W3C, WHATWG, TC39, and other specifications are important resources.
---
5 changes: 5 additions & 0 deletions meta/content/en/related/yari.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Yari"
description: >
The site generator for MDN Web Docs.
---
10 changes: 10 additions & 0 deletions meta/content/en/writing/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Writing docs"
weight: 30
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
11 changes: 11 additions & 0 deletions meta/content/en/writing/browser-compat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Update browser compatibility tables"
linkTitle: "Browser compatibility"
weight: 0
description: >
This page needs a description.
---

{{% pageinfo %}}
This is a placeholder page.
{{% /pageinfo %}}
Loading

0 comments on commit c22e857

Please sign in to comment.