Updated gitignore and README.
This commit is contained in:
parent
87613f77be
commit
e9102cb58d
8
.gitignore
vendored
8
.gitignore
vendored
@ -1,14 +1,8 @@
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
package-lock.json
|
||||
|
||||
node_modules/
|
||||
dist
|
||||
public
|
||||
|
||||
# IDE
|
||||
.idea
|
||||
|
55
README.md
55
README.md
@ -1,55 +1,26 @@
|
||||
# Simple Systems Website
|
||||
|
||||
Built using [Hugo](https://gohugo.io/getting-started/installing/)
|
||||
|
||||
## Local development
|
||||
Build image
|
||||
```shell script
|
||||
docker build -f Dockerfile.dev -t website-fe .
|
||||
```
|
||||
hugo server
|
||||
```
|
||||
|
||||
Run the container using the current directory for the source files
|
||||
```shell script
|
||||
docker run -it -p 8080:8080 --mount source=$(pwd),target=/src,type=bind --rm website-fe
|
||||
## Production
|
||||
To build the production site, run the following command:
|
||||
```
|
||||
hugo --minify
|
||||
```
|
||||
|
||||
## Building (non docker)
|
||||
|
||||
To create a production build, run:
|
||||
```shell script
|
||||
yarn
|
||||
yarn build
|
||||
```
|
||||
|
||||
The static resources will be stored in the `./dist` directory.
|
||||
|
||||
## Production Docker build and run
|
||||
To build the production site in a docker container, run the following command:
|
||||
```shell script
|
||||
docker build -f Dockerfile.prod -t website-rel .
|
||||
```
|
||||
|
||||
To run the production container, run the following command:
|
||||
```shell script
|
||||
docker run --rm -it -p 8080:8080 website-rel
|
||||
```
|
||||
The resources will be stored in the `./public` directory.
|
||||
|
||||
## Managing Job Posts
|
||||
|
||||
To add a job post:
|
||||
1. Place the markdown file in `./src/job-posts`.
|
||||
2. Add the file name (excluding the extension) as an entry `./src/assets/jobKeys.js`.
|
||||
These entries determine the display order.
|
||||
|
||||
To remove a job post:
|
||||
1. Remove the markdown file from `./src/job-posts`.
|
||||
2. Remove the entry from the data in `./src/assets/jobKeys.js`.
|
||||
* To add a job post, create the markdown file in `content/jobs`.
|
||||
* To remove a job post, remove its markdown file from `content/jobs`.
|
||||
|
||||
## Managing Blog Posts
|
||||
|
||||
To add a blog post:
|
||||
1. Place the markdown file in `./src/blog-posts`.
|
||||
2. Add the file name (excluding the extension) as an entry `./src/assets/blogKeys.js`.
|
||||
These entries determine the display order.
|
||||
|
||||
To remove a blog post:
|
||||
1. Remove the markdown file from `./src/blog-posts`.
|
||||
2. Remove the entry from the data in `./src/assets/blogKeys.js`.
|
||||
* To add a blog post, create the markdown file in `content/blog`.
|
||||
* To remove a blog post, remove its markdown file from `content/blog`.
|
||||
|
Loading…
Reference in New Issue
Block a user