moved everything out of the source
directory
|
@ -17,14 +17,14 @@ jobs:
|
||||||
with:
|
with:
|
||||||
node-version: 16
|
node-version: 16
|
||||||
cache: yarn
|
cache: yarn
|
||||||
cache-dependency-path: source/yarn.lock
|
cache-dependency-path: yarn.lock
|
||||||
- name: Install dependencies and Build
|
- name: Install dependencies and Build
|
||||||
run: cd source && yarn install && yarn build
|
run: yarn install && yarn build
|
||||||
- name: Archive Production Artifact
|
- name: Archive Production Artifact
|
||||||
uses: actions/upload-artifact@master
|
uses: actions/upload-artifact@master
|
||||||
with:
|
with:
|
||||||
name: build
|
name: build
|
||||||
path: source/build
|
path: build
|
||||||
|
|
||||||
deploy:
|
deploy:
|
||||||
if: ${{ github.repository_owner == 'developomp' }}
|
if: ${{ github.repository_owner == 'developomp' }}
|
||||||
|
@ -38,7 +38,7 @@ jobs:
|
||||||
uses: actions/download-artifact@master
|
uses: actions/download-artifact@master
|
||||||
with:
|
with:
|
||||||
name: build
|
name: build
|
||||||
path: source/build
|
path: build
|
||||||
- name: Set target
|
- name: Set target
|
||||||
uses: w9jds/firebase-action@master
|
uses: w9jds/firebase-action@master
|
||||||
with:
|
with:
|
||||||
|
|
8
.gitignore
vendored
|
@ -2,10 +2,10 @@
|
||||||
_/
|
_/
|
||||||
|
|
||||||
# auto generated files
|
# auto generated files
|
||||||
source/src/data/
|
/src/data/
|
||||||
!source/src/data/NavbarData.tsx
|
!/src/data/NavbarData.tsx
|
||||||
source/public/img/skills.svg
|
/public/img/skills.svg
|
||||||
source/public/img/projects.svg
|
/public/img/projects.svg
|
||||||
|
|
||||||
# dependencies
|
# dependencies
|
||||||
.pnp/
|
.pnp/
|
||||||
|
|
10
README.md
|
@ -19,19 +19,13 @@ Source code for my (developomp's) <a href="https://developomp.com" target="_blan
|
||||||
git clone https://github.com/developomp/developomp-site.git
|
git clone https://github.com/developomp/developomp-site.git
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 2. Open the [`source`](./source) directory
|
#### 2. Install dependencies
|
||||||
|
|
||||||
```bash
|
|
||||||
cd source
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 3. Install dependencies
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn install
|
yarn install
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 4. Test locally
|
#### 3. Test locally
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn start
|
yarn start
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
{
|
{
|
||||||
"target": "stable",
|
"target": "stable",
|
||||||
"cleanUrls": true,
|
"cleanUrls": true,
|
||||||
"public": "source/build",
|
"public": "build",
|
||||||
"rewrites": [
|
"rewrites": [
|
||||||
{
|
{
|
||||||
"source": "**",
|
"source": "**",
|
||||||
|
|
Before Width: | Height: | Size: 673 B After Width: | Height: | Size: 673 B |
|
@ -29,26 +29,26 @@ The build process of the site can be subdivided into three major stages: _conten
|
||||||
|
|
||||||
Before the site ever gets to deal with react stuff, a sort of content pre-processing should take place.
|
Before the site ever gets to deal with react stuff, a sort of content pre-processing should take place.
|
||||||
In this stage, markdown files are rendered to HTML, svg images are constructed, and json files containing metadata are generated.
|
In this stage, markdown files are rendered to HTML, svg images are constructed, and json files containing metadata are generated.
|
||||||
These files are all saved in the `source/src/data` directory with exceptions for some image files which are saved in the `source/public/img` directory.
|
These files are all saved in the `src/data` directory with exceptions for some image files which are saved in the `public/img` directory.
|
||||||
|
|
||||||
#### A. HTML generation
|
#### A. HTML generation
|
||||||
|
|
||||||
The [markdown files](https://github.com/developomp/developomp-site/tree/master/source/markdown) are rendered to HTML using the [markdown-it](https://github.com/markdown-it/markdown-it) library.
|
The [markdown files](https://github.com/developomp/developomp-site/tree/master/markdown) are rendered to HTML using the [markdown-it](https://github.com/markdown-it/markdown-it) library.
|
||||||
Various extensions are used in this stage to extend markdown features such as footnotes, mathematical expressions, and code blocks.
|
Various extensions are used in this stage to extend markdown features such as footnotes, mathematical expressions, and code blocks.
|
||||||
|
|
||||||
- Check the [test post](/posts/test-post) to see all markdown features.
|
- Check the [test post](/posts/test-post) to see all markdown features.
|
||||||
- Check the [`source/generate/parsemarkdown.ts`](https://github.com/developomp/developomp-site/blob/master/source/generate/parseMarkdown.ts) file to see the conversion logic.
|
- Check the [`generate/parsemarkdown.ts`](https://github.com/developomp/developomp-site/blob/master/generate/parseMarkdown.ts) file to see the conversion logic.
|
||||||
|
|
||||||
#### B. images
|
#### B. images
|
||||||
|
|
||||||
After the all the text contents are parsed, svg images are constructed.
|
After the all the text contents are parsed, svg images are constructed.
|
||||||
|
|
||||||
First, icons from [simple-icons](https://github.com/simple-icons/simple-icons) that are used by the site are saved in the `source/src/data/icons` directory.
|
First, icons from [simple-icons](https://github.com/simple-icons/simple-icons) that are used by the site are saved in the `src/data/icons` directory.
|
||||||
|
|
||||||
Then, other images such as the "programming skills" stats that can be seen in my [portfolio](/portfolio) and in my [github profile](https://github.com/developomp#skills).
|
Then, other images such as the "programming skills" stats that can be seen in my [portfolio](/portfolio) and in my [github profile](https://github.com/developomp#skills).
|
||||||
|
|
||||||
- The [EJS](https://ejs.co) library is used for svg construction.
|
- The [EJS](https://ejs.co) library is used for svg construction.
|
||||||
- The code can be found in [`source/generate/portfolio`](https://github.com/developomp/developomp-site/tree/master/source/generate/portfolio).
|
- The code can be found in [`generate/portfolio`](https://github.com/developomp/developomp-site/tree/master/generate/portfolio).
|
||||||
|
|
||||||
#### C. metadata
|
#### C. metadata
|
||||||
|
|
||||||
|
@ -57,9 +57,9 @@ This can then be imported in react for searching and listing.
|
||||||
|
|
||||||
Files generated in this stage includes:
|
Files generated in this stage includes:
|
||||||
|
|
||||||
- `source/src/data/map.json` (contains information about regular blog posts and pages)
|
- `src/data/map.json` (contains information about regular blog posts and pages)
|
||||||
- `source/src/data/portfolio.json` (contains information about portfolio related data such as my projects)
|
- `src/data/portfolio.json` (contains information about portfolio related data such as my projects)
|
||||||
- `source/src/data/search.json` (contains searchable [elasticlunr](https://github.com/weixsong/elasticlunr.js) index for the search page)
|
- `src/data/search.json` (contains searchable [elasticlunr](https://github.com/weixsong/elasticlunr.js) index for the search page)
|
||||||
|
|
||||||
### 2. site building
|
### 2. site building
|
||||||
|
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 345 B After Width: | Height: | Size: 345 B |
Before Width: | Height: | Size: 155 B After Width: | Height: | Size: 155 B |
Before Width: | Height: | Size: 159 B After Width: | Height: | Size: 159 B |
Before Width: | Height: | Size: 137 B After Width: | Height: | Size: 137 B |
Before Width: | Height: | Size: 142 B After Width: | Height: | Size: 142 B |
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 2.2 KiB |
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 3.5 KiB |
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
Before Width: | Height: | Size: 5 KiB After Width: | Height: | Size: 5 KiB |
Before Width: | Height: | Size: 1.1 MiB After Width: | Height: | Size: 1.1 MiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
Before Width: | Height: | Size: 2.4 MiB After Width: | Height: | Size: 2.4 MiB |
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 4.8 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 480 KiB After Width: | Height: | Size: 480 KiB |
Before Width: | Height: | Size: 8 KiB After Width: | Height: | Size: 8 KiB |
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 74 KiB |
Before Width: | Height: | Size: 229 KiB After Width: | Height: | Size: 229 KiB |
Before Width: | Height: | Size: 1.7 MiB After Width: | Height: | Size: 1.7 MiB |
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
Before Width: | Height: | Size: 1.2 MiB After Width: | Height: | Size: 1.2 MiB |
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 759 KiB After Width: | Height: | Size: 759 KiB |
Before Width: | Height: | Size: 350 KiB After Width: | Height: | Size: 350 KiB |
Before Width: | Height: | Size: 9.3 KiB After Width: | Height: | Size: 9.3 KiB |
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |