#Ufocus markdown install#
#Ufocus markdown code#

On the translated-content repository go to the Issues tab and click on the “New issue” button.

There are some customizations, but in general, it is based on GitHub flavoured Markdown. NOTE: You can find a useful reference to the flavor of Markdown supported on MDN Web Docs. As long as you are comfortable with Markdown and some HTML, you will be able to contribute. You do not need to understand the language to do the conversion. The worksheets are sorted in the order of the number of documents to be converted in each language – from the lowest to the highest. We maintain a list of documents that need to be converted to Markdown in this Google sheet. I will touch on some specific commands here, but for detailed documentation, please check out the markdown repo’s README. # This moves you out of the `markdown` folder env with the following contents: CONTENT_TRANSLATED_ROOT=./translated-content/files Setting up the content repository cd. In the root of the directory, create a new file called.

You’ll also need to add some configuration via an. Gh repo clone username/translated-content # replace username with your GitHub username Setting up the conversion tool cd markdown We will make direct clones of the other two repositories.Ĭlone the above repositories and your fork of translated-content as follows using the GitHub CLI: gh repo clone mdn/markdown You only need to fork the translated-content repository.

#Ufocus markdown code#

You’ll need code and content from several repositories for this project, as listed below. This should output a Nodejs version number that is similar to v16.15.1.

#Ufocus markdown install#

Once all of the above is installed, install Nodejs version 16 with NVM: nvm install 16 (Encouraged, but optional, i.e., if you are already comfortable using Git, you can accomplish all the same tasks without the need for the GitHub CLI.) Nodejs

The GitHub CLI to follow the commands below.

We’re tracking source code and managing contributions on GitHub, so the following will be needed: On Windows, there are a couple of options: To check, open your terminal and run: git -version If you are on Linux or macOS, you may already have Git. If you do not have git installed, you can follow the steps described on this getting started page.

This section describes the tools you’ll need to participate in this project. Here is the tracking issue for this project on the translated content repository.

All content in Markdown will allow the MDN Web Docs team to run the same linting rules across all active languages.

Better tooling will lead to a more enjoyable contribution workflow. Having less code to maintain will enable them to focus on improving the tooling for writers and contributors.

With all content in Markdown, the MDN engineering team will be able to clean up a lot of the currently maintained code.

Having all content in Markdown will help create a unified contribution experience across languages and repositories.

Markdown is a much more approachable and friendlier way to contribute to MDN Web Docs content.

We want to get all active content on MDN Web Docs to Markdown for several reasons. In this post, we’ll describe why we decided to migrate to Markdown, and the steps you can take that will help us on our mission. The goal was to get 100% of our manually-written documentation converted to Markdown, and we really had a mountain of source code to climb for this particular expedition. In June 2021, we decided to start converting the source code for MDN web docs from HTML into a format that would be easier for us to work with.