Documentation website #1526
Documentation website #1526
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Also move 'Design', 'Spec', and 'Project' sections into top nav
|
@emlai, What if, we use the CppNorth video as iframe in the website instead of using the video link? |
|
@nomandhoni-cs Hi! You can contribute by making a PR to this branch in my fork. We can sync on the Carbon Discord, I'm emlai#9471 there. As for converting youtube links into embeds in the markdown, it should be possible using remark plugins such as https://github.com/agentofuser/remark-oembed. |
|
Depends on #1492 |
|
This is looking really promising! It looks like mermaid diagrams aren't being rendered by this documentation generation pipeline: for example, the precedence diagram at https://emlai.github.io/docs/design/expressions/ is rendered as text. It looks like there's an external implementation of mermaid rendering for docusaurus available already, and native support coming soon. |
|
We triage inactive PRs and issues in order to make it easier to find active work. If this PR should remain active, please comment or remove the |
github-actions
bot
added
the
inactive
|
We triage inactive PRs and issues in order to make it easier to find active work. If this PR should remain active or becomes active again, please reopen it. |
Demo site: https://jonmeow.carbon-lang.dev/ I'm trying to keep work under the `/website` subdirectory so that the misc files don't interfere with unrelated views of the repository. The `prebuild.py` script does some work to move things around and add frontmatter, helping the jekyll generation. I'm using the "just-the-docs" theme because I think it's a decent match for what we want, and getting jekyll up and running with it wasn't too difficult. Note #1526 proposed using Docusaurus; I started out there, but was having trouble getting it working with newer versions. The plugins in particular I got stuck trying to make work, which sent me looking for options that we could have working with less customization. I do lean towards jekyll though, because it's what GH uses so hopefully we can get a more consistent experience. Having a website has been approved for a while under #1492, but hasn't been a priority. I'm mainly doing this because I want to just be able to point people to carbon-lang.dev and have easy links that way. --------- Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
Closes #1492. Adds a website that is auto-generated from the markdown files in the repo, using Docusaurus. This will make it easier to browse the docs, by adding a navigation sidebar as well as a table-of-contents sidebar, mobile support, and other things. The site can be autodeployed to https://carbon-language.github.io/ (or to a custom domain using a CNAME file), and is currently configured accordingly (deployment instructions in website/README.md).
docs/.Preview: https://emlai.github.io/
To do:
Follow-up improvements (non-blocking tasks that are not necessary for merging this PR):
<!--:<meta data-rh="true" name="description" content="<!--">How to test
Go to https://emlai.github.io/ and check that links, navigation, etc. works, and everything looks ok.