Skip to content

Commit c22e857

Browse files
ddbeckddbeck
authored
Set up base meta docs site with Hugo (mdn#11200)
* 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
1 parent 09dafad commit c22e857

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+2016
-0
lines changed

Diff for: ‎.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "meta/themes/docsy"]
2+
path = meta/themes/docsy
3+
url = https://github.com/google/docsy.git

Diff for: ‎meta/.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.hugo_build.lock
2+
node_modules
3+
public/
4+
resources/

Diff for: ‎meta/config.toml

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
baseURL = "/"
2+
title = "MDN Web Docs for Contributors"
3+
4+
enableRobotsTXT = true
5+
6+
# Hugo allows theme composition (and inheritance). The precedence is from left to right.
7+
theme = ["docsy"]
8+
9+
# Will give values to .Lastmod etc.
10+
enableGitInfo = true
11+
12+
# Language settings
13+
contentDir = "content/en"
14+
defaultContentLanguage = "en"
15+
defaultContentLanguageInSubdir = false
16+
17+
# Useful when translating.
18+
enableMissingTranslationPlaceholders = true
19+
20+
# Highlighting config
21+
pygmentsCodeFences = true
22+
pygmentsUseClasses = false
23+
# Use the new Chroma Go highlighter in Hugo.
24+
pygmentsUseClassic = false
25+
#pygmentsOptions = "linenos=table"
26+
# See https://help.farbox.com/pygments.html
27+
pygmentsStyle = "tango"
28+
29+
disableKinds = ["taxonomy", "taxonomyTerm", "tags", "tag"]
30+
[taxonomies]
31+
# tag = 'tags'
32+
33+
# Configure how URLs look like per section.
34+
[permalinks]
35+
blog = "/:section/:year/:month/:day/:slug/"
36+
37+
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
38+
[blackfriday]
39+
plainIDAnchors = true
40+
hrefTargetBlank = true
41+
angledQuotes = false
42+
latexDashes = true
43+
44+
[imaging]
45+
resampleFilter = "CatmullRom"
46+
quality = 75
47+
anchor = "smart"
48+
49+
[languages]
50+
[languages.en]
51+
title = "MDN Web Docs for Contributors"
52+
description = "Documentation for documenters"
53+
languageName ="English"
54+
weight = 1
55+
56+
[markup]
57+
[markup.goldmark]
58+
[markup.goldmark.renderer]
59+
unsafe = true
60+
[markup.highlight]
61+
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
62+
style = "tango"
63+
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
64+
# guessSyntax = "true"
65+
66+
[params]
67+
copyright = "Mozilla and contributors"
68+
privacy_policy = "https://www.mozilla.org/en-US/privacy/websites/"
69+
github_repo = "https://github.com/mdn/content"
70+
github_branch = "main"
71+
prism_syntax_highlighting = false
72+
73+
# [[params.links.user]]
74+
# name = "Stack Overflow"
75+
# url = "https://example.org/stack"
76+
# icon = "fab fa-stack-overflow"
77+
# desc = "Practical questions and curated answers"
78+
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
79+
# [[params.links.developer]]
80+
# name = "GitHub"
81+
# url = "https://github.com/google/docsy"
82+
# icon = "fab fa-github"
83+
# desc = "Development takes place here!"
84+
# [[params.links.developer]]
85+
# name = "Slack"
86+
# url = "https://example.org/slack"
87+
# icon = "fab fa-slack"
88+
# desc = "Chat with other project developers"
89+
# [[params.links.developer]]
90+
# name = "Developer mailing list"
91+
# url = "https://example.org/mail"
92+
# icon = "fa fa-envelope"
93+
# desc = "Discuss development issues around the project"

Diff for: ‎meta/content/en/_index.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: "MDN Web Docs for Contributors"
3+
linkTitle: "Home"
4+
weight: 20
5+
layout: docs
6+
menu:
7+
main:
8+
weight: 20
9+
10+
# forces the whole site to use the "docs" structure in Docsy
11+
cascade:
12+
- type: "docs"
13+
_target:
14+
path: "/**"
15+
---
16+
17+
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/).

Diff for: ‎meta/content/en/changelog.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Changelog"
3+
weight: 100
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/community/_index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Community"
3+
weight: 20
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/community/etiquette.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Etiquette and expectations for behavior"
3+
weight: 30
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/community/fora.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Where to get help"
3+
weight: 20
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
<!-- GitHub discussions, Matrix chat, Discourse -->
9+
10+
{{% pageinfo %}}
11+
This is a placeholder page.
12+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/community/people.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Who makes MDN?"
3+
weight: 10
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
<!-- Contributors, peers, owners… and you? -->
9+
10+
{{% pageinfo %}}
11+
This is a placeholder page.
12+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/community/report-cpg-spam.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Report spam and other community issues"
3+
weight: 40
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
<!-- Need a process for this! -->
9+
10+
{{% pageinfo %}}
11+
This is a placeholder page.
12+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/get-started/_index.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
categories: ["Examples", "Placeholders"]
3+
tags: ["test","docs"]
4+
title: "Get started"
5+
weight: 2
6+
description: >
7+
If you're a first-time contributor to MDN Web Docs, start here.
8+
---

Diff for: ‎meta/content/en/get-started/ways-to-contribute.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Ways to contribute"
3+
date: 2017-01-05
4+
weight: 20
5+
description: >
6+
You can contribute in many ways, from reporting problems to writing docs to developing the platform.
7+
---
8+
9+
<!--
10+
11+
- Create and improve docs
12+
- Report issues
13+
- Write and edit
14+
- Review PRs
15+
- Translate
16+
- Participate in discussions and peer learning
17+
- Develop the platform
18+
19+
- NEXT: learn about the community and
20+
21+
-->
22+
23+
{{% pageinfo %}}
24+
This is a placeholder page.
25+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/get-started/why.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Why you should contribute to MDN"
3+
weight: 10
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/governance/_index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Governance and process"
3+
weight: 30
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/governance/issues/_index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Issues"
3+
weight: 0
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/governance/issues/triage.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Triage an issue"
3+
weight: 0
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/governance/meetings.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Meetings"
3+
weight: 3
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/governance/pulls/_index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Pull requests"
3+
weight: 0
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/governance/pulls/review.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Review a pull request"
3+
weight: 0
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/governance/roadmap.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "What we document"
3+
weight: 2
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/governance/roles-and-responsibilities.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Roles and responsibilities"
3+
weight: 1
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/legacy/_index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Legacy documentation"
3+
weight: 1000
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/related/_index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Related projects and resources"
3+
weight: 100
4+
description: >
5+
More stuff that's useful.
6+
---

Diff for: ‎meta/content/en/related/browser-compat-data.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "@mdn/browser-compat-data"
3+
description: >
4+
Browser interoperability data that powers tables on MDN, caniuse, and more.
5+
---

Diff for: ‎meta/content/en/related/repositories.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "All GitHub repositories"
3+
weight: 1
4+
description: >
5+
A list of every MDN repository and what it's for.
6+
---

Diff for: ‎meta/content/en/related/specifications.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Web specifications"
3+
description: >
4+
W3C, WHATWG, TC39, and other specifications are important resources.
5+
---

Diff for: ‎meta/content/en/related/yari.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Yari"
3+
description: >
4+
The site generator for MDN Web Docs.
5+
---

Diff for: ‎meta/content/en/writing/_index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Writing docs"
3+
weight: 30
4+
description: >
5+
This page needs a description.
6+
---
7+
8+
{{% pageinfo %}}
9+
This is a placeholder page.
10+
{{% /pageinfo %}}

Diff for: ‎meta/content/en/writing/browser-compat.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "Update browser compatibility tables"
3+
linkTitle: "Browser compatibility"
4+
weight: 0
5+
description: >
6+
This page needs a description.
7+
---
8+
9+
{{% pageinfo %}}
10+
This is a placeholder page.
11+
{{% /pageinfo %}}

0 commit comments

Comments
 (0)