https://github.com/libp2p/blog
Blog site for the libp2p project.
https://github.com/libp2p/blog
type-website
Last synced: about 1 year ago
JSON representation
Blog site for the libp2p project.
- Host: GitHub
- URL: https://github.com/libp2p/blog
- Owner: libp2p
- License: mit
- Created: 2022-11-22T06:22:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-14T10:07:22.000Z (over 1 year ago)
- Last Synced: 2025-03-26T05:23:26.264Z (over 1 year ago)
- Topics: type-website
- Language: Vue
- Homepage:
- Size: 115 MB
- Stars: 9
- Watchers: 18
- Forks: 7
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# libp2p Blog & News
[](https://protocol.ai)
[](https://vuepress.vuejs.org/)
[](http://fleek.co/)
This repository contains code and content for the [libp2p Blog & News](https://blog.libp2p.io/) website.
### Adding your blog entry
It's recommend that you add your blog entry manually by creating a new Markdown file and creating a pull request.
This allows us to review blog posts line by line and go through a proper review cycle.
The steps are as follows:
1. Add your new file in `src/_blog`
2. Add any images or assets in `src/assets`
3. Add the path to your Markdown file in a new line in the file `.forestry/front_matter/templates/blog-post.yml`
When writing a new post, you'll also need to fill in the header information:
```
---
tags:
-
- libp2p
title:
description:
date:
permalink:
translationKey:
header_image:
author:
---
```
Here is an example pull request that adds a new blog entry for reference: https://github.com/libp2p/blog/pull/33/files
### Build and run locally
This site is built in [Vuepress](https://vuepress.vuejs.org/guide/), and uses Vue/JavaScript for functional code and Markdown for post content.
To build a local copy, run the following:
1. Clone this repository:
```bash
git clone https://github.com/libp2p/blog.git
```
1. Move into the `blog` folder and install the npm dependencies:
```bash
cd blog
npm install
```
1. Start the application in _dev mode_:
```bash
npm ci
NODE_OPTIONS=--openssl-legacy-provider npm start
```
1. Open [localhost:8080](http://localhost:8080) in your browser.
You can close the local server with `CTRL` + `c`. To restart the local server, run `npm start` from inside the `blog` directory.
### PR and preview
Once you're happy with your local changes, please make a PR **against the `main` branch**. Including detailed notes on your PR - particularly screenshots to depict any changes in UI - will help speed up approval and deployment.
All PRs against `main` automatically generate Fleek previews to make it easier to "check your work". You can view your PR's preview by clicking `Details` in the `fleek/build` check at the bottom of your PR page:
A reviewer will be by shortly to have a look!
## Maintainers
This site's codebase is under active maintenance by members of the core [libp2p team](https://libp2p.io/).
## License
© Protocol Labs | Code is licensed with the [MIT](LICENSE) License. Except as noted, other content licensed [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/us/).