-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README with instructions to add a new blog post
- Loading branch information
1 parent
e72a01b
commit 566f934
Showing
1 changed file
with
12 additions
and
18 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,41 +1,35 @@ | ||
# Website | ||
|
||
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. | ||
This website is built using [Docusaurus](https://docusaurus.io/). | ||
|
||
### Installation | ||
## Adding a blog post | ||
1. New posts are created in [./blog/](./blog) folder. For reference see [this post](/blog/2024-05-12-meetup-3-and-ann-next-meetup.md) | ||
2. Feel free to add yourself [here](/blog/authors.yml) as an author | ||
3. Add yourself as an author (or co-author if you're collaborating) in the post's headers. | ||
|
||
|
||
## Installation | ||
|
||
``` | ||
$ yarn | ||
``` | ||
|
||
### Local Development | ||
## Local Development | ||
|
||
``` | ||
$ yarn start | ||
``` | ||
|
||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
### Build | ||
## Build | ||
|
||
``` | ||
$ yarn build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
### Deployment | ||
|
||
Using SSH: | ||
|
||
``` | ||
$ USE_SSH=true yarn deploy | ||
``` | ||
|
||
Not using SSH: | ||
|
||
``` | ||
$ GIT_USER=<Your GitHub username> yarn deploy | ||
``` | ||
## Deployment | ||
|
||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. | ||
We use Github Actions to deploy the website. See [./.github/workflows](./.github/workflows). For the domain, contact [ManasJayanth](https://github.com/ManasJayanth). |