Skip to content

Commit ec9f943

Browse files
committed
docs: fix README markdown formatting
1 parent 7f26332 commit ec9f943

File tree

1 file changed

+40
-46
lines changed

1 file changed

+40
-46
lines changed

README.md

Lines changed: 40 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Status](https://api.travis-ci.com/edx/frontend-build.svg?branch=master)](https:/
1111
The purpose of this package is to provide a common sense foundation and
1212
setup for frontend projects including:
1313

14-
- linting (eslint)
15-
- testing (jest)
16-
- development server (webpack-dev-server)
17-
- build (webpack)
14+
- linting (eslint)
15+
- testing (jest)
16+
- development server (webpack-dev-server)
17+
- build (webpack)
1818

1919
This package can serve as a single dev dependency replacing a large
2020
number of dev and build dependencies. It aims to provide common sense
@@ -23,22 +23,20 @@ can extended or overridden where needed.
2323

2424
## Cloning and Startup
2525

26-
``` {.}
2726
1. Clone your new repo:
2827

29-
``git clone https://github.com/openedx/frontend-build.git``
28+
git clone https://github.com/openedx/frontend-build.git
3029

31-
2. Use node v18.x.
30+
2. Use node v18.x:
3231

33-
The current version of the micro-frontend build scripts support node 18.
34-
Using other major versions of node *may* work, but this is unsupported. For
35-
convenience, this repository includes an .nvmrc file to help in setting the
36-
correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
32+
> The current version of the micro-frontend build scripts support node 18.
33+
> Using other major versions of node *may* work, but this is unsupported. For
34+
> convenience, this repository includes an .nvmrc file to help in setting the
35+
> correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
3736
3837
3. Install npm dependencies:
3938

40-
``cd frontend-build && npm ci``
41-
```
39+
cd frontend-build && npm ci
4240

4341
## Usage
4442

@@ -70,26 +68,26 @@ package.json:
7068

7169
This package contains a set of configuration presets:
7270

73-
- webpack-prod (or webpack)
74-
- webpack-dev (or webpack-dev-server)
75-
- webpack-dev-stage (for running development apps against stage apis)
76-
- babel
77-
- babel-preserve-modules
78-
- jest
79-
- eslint
71+
- webpack-prod (or webpack)
72+
- webpack-dev (or webpack-dev-server)
73+
- webpack-dev-stage (for running development apps against stage apis)
74+
- babel
75+
- babel-preserve-modules
76+
- jest
77+
- eslint
8078

8179
If you need to extend or modify a configuration you can add your own
8280
configuration files, either by extending frontend-build\'s configuration
8381
files or supplying your own wholesale.
8482

85-
Method 1: Extend base config (babel.config.js):
83+
### Method 1: Extend base config (babel.config.js)
8684

8785
const { createConfig } = require('@openedx/frontend-build');
8886
module.exports = createConfig('babel', {
8987
/* option overrides or extensions */
9088
});
9189

92-
Method 2: Custom manipulations (babel.config.js):
90+
### Method 2: Custom manipulations (babel.config.js)
9391

9492
const { getBaseConfig } = require('@openedx/frontend-build');
9593
const config = getBaseConfig('babel');
@@ -101,11 +99,11 @@ Method 2: Custom manipulations (babel.config.js):
10199
Frontend build will look in the following locations for configuration
102100
files in your project.
103101

104-
- eslint: `<project_root>/.eslintrc.js`
105-
- jest: `<project_root>/jest.config.js`
106-
- babel: `<project_root>/babel.config.js`
107-
- webpack-prod: `<project_root>/webpack.prod.config.js`
108-
- webpack-dev-server: `<project_root>/webpack.dev.config.js`
102+
- eslint: `<project_root>/.eslintrc.js`
103+
- jest: `<project_root>/jest.config.js`
104+
- babel: `<project_root>/babel.config.js`
105+
- webpack-prod: `<project_root>/webpack.prod.config.js`
106+
- webpack-dev-server: `<project_root>/webpack.dev.config.js`
109107

110108
You may specify custom config file locations via the command line if you
111109
prefer a different location. Example package.json:
@@ -138,8 +136,7 @@ location of that repository to your module.config.js file and the
138136
webpack build for your application will automatically pick it up and use
139137
it, rather than its node\_modules version of the file.
140138

141-
**NOTE: This module.config.js file should be added to your**
142-
[.gitignore]{.title-ref}.
139+
**NOTE: This module.config.js file should be added to your `.gitignore`.**
143140

144141
An example module.config.js file looks like the following. You can copy
145142
this into your application to use local versions of paragon and
@@ -173,19 +170,17 @@ frontend-platform:
173170

174171
## Notes
175172

176-
- The \"dir\" and \"dist\" keys give you granular control over the
177-
shape of your repository\'s distribution. Paragon, for instance,
178-
needs two separate entries to pick up both JS and SCSS imports.
179-
- The directory location `../src` (relative to the root of your
180-
frontend app repository) is recommended for shared NPM package
181-
repositories, since it will work whether or not you are running your
182-
frontend via devstack. If you are *not* running your frontend via
183-
devstack, then you can place your shared libraries anywhere in your
184-
file system, updating the \"dir\" key accordingly. To learn more,
185-
see [this devstack ADR on local
186-
packages](https://github.com/openedx/devstack/tree/master/docs/decisions/0005-frontend-package-mounts.rst).
187-
- This mechanism uses Webpack resolve aliases, as documented here:
188-
<https://webpack.js.org/configuration/resolve/#resolvealias>
173+
- The \"dir\" and \"dist\" keys give you granular control over the
174+
shape of your repository\'s distribution. Paragon, for instance,
175+
needs two separate entries to pick up both JS and SCSS imports.
176+
- The directory location `../src` (relative to the root of your frontend app repository)
177+
is recommended for shared NPM package repositories, since it will work whether or
178+
not you are running your frontend via devstack. If you are *not* running your
179+
frontend via devstack, then you can place your shared libraries anywhere in your
180+
file system, updating the \"dir\" key accordingly. To learn more, see [this devstack
181+
ADR on local
182+
packages](https://github.com/openedx/devstack/tree/master/docs/decisions/0005-frontend-package-mounts.rst).
183+
- This mechanism uses Webpack resolve aliases, as documented here: https://webpack.js.org/configuration/resolve/#resolvealias
189184

190185
## Override default .env.development environment variables with .env.private
191186

@@ -196,8 +191,8 @@ that should never be checked into a repository. For example, a
196191
(e.g., Algolia) that you\'d like to use during development but want to
197192
ensure these secrets are not checked into Git.
198193

199-
You may create a [.env.private]{.title-ref} with any overrides of the
200-
environment settings configured in [.env.development]{.title-ref}.
194+
You may create a `.env.private` with any overrides of the
195+
environment settings configured in `.env.development`.
201196

202197
**Note: .env.private should be added to your project\'s .gitignore so it
203198
does not get checked in.**
@@ -295,8 +290,7 @@ Help](https://openedx.org/community/connect) page.
295290

296291
## Reporting Security Issues
297292

298-
Please do not report security issues in public. Please email
299-
293+
Please do not report security issues in public. Please email [email protected].
300294

301295
## Optimization
302296

0 commit comments

Comments
 (0)