vLLM
/
vllm-project.github.io
mirror of https://github.com/vllm-project/vllm-project.github.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#25)

This commit is contained in:
Harry Mellor 2025-02-07 00:44:22 +00:00 committed by GitHub
parent 95bece8af7
commit f74517c7fe
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,22 +1,19 @@
# vLLM Blog Source
How to compile the blogpost:
How to compile the blogpost locally:
1. Install `jekyll` and `bundler` by running `gem install jekyll bundler`. Ask ChatGPT for help if you encounter any issues.
2. `bundle install` to install the necessary gems.
3. `rm ./Gemfile.lock` if you meet gem error.
4. `bundle exec jekyll server` to compile and start the server.
5. `bundle exec jekyll server` to compile and start the server.
To add a new blogpost, please refer to `_posts/2023-06-20-vllm.md` as an example. Some notes:
- Google Doc can be saved as markdown format which will make your life easier.
- Note that the blogpost will only show when its date is in the past.
- Put figures under `assets/figures/yourblogname/`.
- Push your edits to this repo to save your changes.
- Make a pull request.
To publish:
- `JEKYLL_ENV=production bundle exec jekyll build` to compile the blogpost fresh.
- After you finish writing, copy the whole content of `_site/` to `vllm-project.github.io` and push to the github repo.
- Note that there is a `CNAME` file in the `vllm-project.github.io` that is not included in `_site/`. Please do not delete it.
The blog is automatically built and deployed by GitHub Actions when `main` is pushed to.
---
Please find the original README below.