pomp/pompy.dev
1
0
Fork 0
Code Issues 8 Pull requests Activity Actions

updated README.md

Browse source
This commit is contained in:
Kim, Jimin 2021-05-16 18:33:54 +09:00
parent 5497251195
commit 2b10086cc6
1 changed files with 14 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -2,7 +2,7 @@
Repository for my (developomp's) <a href="https://developomp.com" target="_blank">website</a>. Repository for my (developomp's) <a href="https://developomp.com" target="_blank">website</a>.
Tools/Frameworks/Packages used: Tools / Frameworks / Packages used:
| Name | Use | | Name | Use |
| ----------------------------------------------------------------------------: | :---------------------------------------------------- | | ----------------------------------------------------------------------------: | :---------------------------------------------------- |
@ -19,7 +19,7 @@ Tools/Frameworks/Packages used:
| [styled-components](https://github.com/styled-components/styled-components) | easier CSS styling | | [styled-components](https://github.com/styled-components/styled-components) | easier CSS styling |
| [styled-theming](https://github.com/styled-components/styled-theming) | Theming | | [styled-theming](https://github.com/styled-components/styled-theming) | Theming |
| [eslint](https://github.com/eslint/eslint) | code analysis | | [eslint](https://github.com/eslint/eslint) | code analysis |
| [prettier](https://github.com/prettier/prettier) | code formatter | | [prettier](https://github.com/prettier/prettier) | code formatting |
| [ts-node](https://github.com/TypeStrong/ts-node) | running markdown-to-html generator | | [ts-node](https://github.com/TypeStrong/ts-node) | running markdown-to-html generator |
| [jest](https://jestjs.io) | code testing | | [jest](https://jestjs.io) | code testing |
@ -28,24 +28,23 @@ Tools/Frameworks/Packages used:
Requirement: Requirement:
- [node](https://nodejs.org) - [node](https://nodejs.org)
- [yarn](https://github.com/yarnpkg/yarn) or [npm](https://github.com/npm/cli)\* - [yarn](https://github.com/yarnpkg/yarn) ([npm](https://github.com/npm/cli) is **not** supported)
- optional: - optional:
- [git](https://git-scm.com) - [git](https://git-scm.com)
- [vscode](https://code.visualstudio.com) - [vscode](https://code.visualstudio.com)
- extensions (also optional but recommended): - extensions (also optional but highly recommended):
- [styled components](https://marketplace.visualstudio.com/items?itemName=jpoissonnier.vscode-styled-components) - [styled components](https://marketplace.visualstudio.com/items?itemName=jpoissonnier.vscode-styled-components) by Julien Poissonnier
- [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) by Prettier
- [react](https://marketplace.visualstudio.com/items?itemName=dsznajder.es7-react-js-snippets) - [ES7 React/Redux/GraphQL/React-Native snippets](https://marketplace.visualstudio.com/items?itemName=dsznajder.es7-react-js-snippets) by dsznajder
- [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) by Dirk Baeumer
- [Color Highlight](https://marketplace.visualstudio.com/items?itemName=naumovs.color-highlight) by Sergii Naumov
\*Usage of yarn is highly recommended over npm
Steps: Steps:
- Clone this repository - Clone this repository
- `git clone https://github.com/developomp/developomp-site.git` - `git clone https://github.com/developomp/developomp-site.git`
- Or download compressed as zip - Or download as a zip file
- ![](./downloading.png) - ![download procedure](./downloading.png)
- open [`source`](./source) directory - open [`source`](./source) directory
- `cd source` - `cd source`
- Install dependencies (must be in `source` directory) - Install dependencies (must be in `source` directory)
@ -53,28 +52,15 @@ Steps:
- start local server in http://localhost:3000 - start local server in http://localhost:3000
- `yarn start` - `yarn start`
# How it works
single page application
react to build front end
components
sunning `yarn generate` converts markdown to html and in json with parsed meta
by date, etc.
Does not scale well but I won't have 10k posts any time soon
few thousand so more than good enough
generator underscore
no symbolic links
filename encoder not perfect. Some filenames might cause problem.
# Contributing # Contributing
Please read the [`CONTRIBUTING.md`](./CONTRIBUTING.md) file. Please read the [`CONTRIBUTING.md`](./CONTRIBUTING.md) file.
# Special thanks # Special thanks
- design inspirations from [Ruipeng Zhang](https://github.com/ppoffice)'s [icarus theme](https://github.com/ppoffice/hexo-theme-icarus) for [hexo](https://github.com/hexojs/hexo). - [Ruipeng Zhang](https://github.com/ppoffice) for design inspiration ([hexo-icarus-theme](https://github.com/ppoffice/hexo-theme-icarus))
- dark theme color from [discord](http://discord.com) - [discord](http://discord.com) for dark theme color palette
- My friend [Aditya Prakash](https://github.com/AdityaPrakash-26) for extensive testing and wonderful suggestions
# License # License