-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: prettify entire codebase also with prose-wrap
- Loading branch information
Showing
99 changed files
with
15,557 additions
and
12,906 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
{ | ||
"extends": "next/core-web-vitals" | ||
"extends": "next/core-web-vitals" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,6 @@ | |
"tabWidth": 4, | ||
"semi": true, | ||
"singleQuote": false, | ||
"endOfLine": "lf" | ||
"endOfLine": "lf", | ||
"proseWrap": "always" | ||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,4 +18,4 @@ | |
// Git Lens | ||
"eamodio.gitlens" | ||
] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,4 +9,4 @@ | |
"[mdx]": { | ||
"editor.wordWrap": "on" | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,60 @@ | ||
# 🚧 This is a work in progress | ||
|
||
If you'd like to be part of the development of sPhil, kindly follow the instructions below. If you have any further questions or would like to get involved, [get in touch with Filip (Firgrep) here](mailto:[email protected]). | ||
If you'd like to be part of the development of sPhil, kindly follow the | ||
instructions below. If you have any further questions or would like to get | ||
involved, | ||
[get in touch with Filip (Firgrep) here](mailto:[email protected]). | ||
|
||
## Setting up your local environment and branch | ||
|
||
0.0. Once you have access to the repo on github, fork and/or clone it into a folder where you keep your projects. | ||
0.0. Once you have access to the repo on github, fork and/or clone it into a | ||
folder where you keep your projects. | ||
|
||
0.1. Then `cd sphil` to get into the project directory. | ||
|
||
0.2. Make your own development branch `git branch dev-<your-name>` (example: `git branch dev-tim`). | ||
0.2. Make your own development branch `git branch dev-<your-name>` (example: | ||
`git branch dev-tim`). | ||
|
||
0.3. Set the newly made development branch as the current active branch, run `git checkout <your-branch-name>`. | ||
0.3. Set the newly made development branch as the current active branch, run | ||
`git checkout <your-branch-name>`. | ||
|
||
0.4. In future, when getting the latest changes from the main development branch, run `git merge dev` whilst on your development branch to incorporate the changes into your branch. | ||
0.4. In future, when getting the latest changes from the main development | ||
branch, run `git merge dev` whilst on your development branch to incorporate the | ||
changes into your branch. | ||
|
||
### Packages Installation | ||
|
||
1.0. Once inside, run `npm i` (alias `npm install`) to install all the packages. This will create the `/node_modules` folder. | ||
1.0. Once inside, run `npm i` (alias `npm install`) to install all the packages. | ||
This will create the `/node_modules` folder. | ||
|
||
### Environmental Variables | ||
|
||
2.0. There are no environmental variables! This is a static website. (Caveat: we defined some public variables depending on where the site is hosted.) | ||
2.0. There are no environmental variables! This is a static website. (Caveat: we | ||
defined some public variables depending on where the site is hosted.) | ||
|
||
### Running the Server | ||
|
||
9.9. Finally, to start a local development server, run `npm run dev` and open up `http://localhost:3000` on your favorite browser. | ||
9.9. Finally, to start a local development server, run `npm run dev` and open up | ||
`http://localhost:3000` on your favorite browser. | ||
|
||
- Whenever you make any edits to the source files while the server is running, the server will pick up those changes and output them immediately. This is extremely handy during development, as you can input code and hit `ctrl` + `k` then `s` (save-all) and view directly your latest changes. | ||
- To terminate the server, hit `ctrl` + `c` on your keyboard whilst in the terminal where the server runs, input `y` when prompted to terminate batch job. | ||
- Whenever you make any edits to the source files while the server is running, | ||
the server will pick up those changes and output them immediately. This is | ||
extremely handy during development, as you can input code and hit `ctrl` + | ||
`k` then `s` (save-all) and view directly your latest changes. | ||
- To terminate the server, hit `ctrl` + `c` on your keyboard whilst in the | ||
terminal where the server runs, input `y` when prompted to terminate batch | ||
job. | ||
|
||
> ❗ You may get an error (e.g. `useRef` is `null`) as your development server refreshes. This is likely due to how `nextra` processes the `mdx` files. Perform a hard refresh (hit `F5`) to resolve this. | ||
> ❗ You may get an error (e.g. `useRef` is `null`) as your development server | ||
> refreshes. This is likely due to how `nextra` processes the `mdx` files. | ||
> Perform a hard refresh (hit `F5`) to resolve this. | ||
## License | ||
|
||
All files and content under `/src/pages`, with the exception of `/src/pages/_app.mdx`, `/src/pages/_document.tsx`, `/src/pages/acknowledgements.tsx`, `/src/pages/index.mdx`, `/src/pages/privacy.tsx`, `/src/pages/team.mdx`, `/src/pages/terms.mdx`, any files within `src/pages/contributing` folder and any `_meta.json` files, are subject to Attribution-NonCommercial-ShareAlike 4.0 International License. The rest follows Apache License Version 2.0, January 2004. | ||
All files and content under `/src/pages`, with the exception of | ||
`/src/pages/_app.mdx`, `/src/pages/_document.tsx`, | ||
`/src/pages/acknowledgements.tsx`, `/src/pages/index.mdx`, | ||
`/src/pages/privacy.tsx`, `/src/pages/team.mdx`, `/src/pages/terms.mdx`, any | ||
files within `src/pages/contributing` folder and any `_meta.json` files, are | ||
subject to Attribution-NonCommercial-ShareAlike 4.0 International License. The | ||
rest follows Apache License Version 2.0, January 2004. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,20 @@ | ||
/** @type {import('next').NextConfig} */ | ||
const nextConfig = { | ||
output: 'export', | ||
reactStrictMode: true, | ||
images: { | ||
unoptimized: true | ||
}, | ||
distDir: "build", | ||
} | ||
output: "export", | ||
reactStrictMode: true, | ||
images: { | ||
unoptimized: true, | ||
}, | ||
distDir: "build", | ||
}; | ||
|
||
const withNextra = require("nextra")({ | ||
theme: "nextra-theme-docs", | ||
themeConfig: "./theme.config.tsx", | ||
// options | ||
// flexsearch: true, | ||
// staticImage: true, | ||
// defaultShowCopyCode: true, | ||
theme: "nextra-theme-docs", | ||
themeConfig: "./theme.config.tsx", | ||
// options | ||
// flexsearch: true, | ||
// staticImage: true, | ||
// defaultShowCopyCode: true, | ||
}); | ||
|
||
module.exports = withNextra(nextConfig); |
Oops, something went wrong.