Welcome to the Web3sec.News Blog repository, an Open Source ultimate community-driven platform 📖 for the latest news and insights on web3 development, security, jobs, blockchain technology, and audits.
Here's a step-by-step guide on how to write a blog in Markdown format and submit a pull request (PR) to get your blog published on our website. Even if you're not a tech-savvy person, this guide will help you contribute your valuable content effortlessly and receive proper credits as the writer of the blog as you write.
- Share twitter threads as a blog of your own 🕊️
- Enter any URL to get it's MD file, make some changes & raise a PR to publish 💪
- Publish your own blog
- Share tips from your own experience
- Use appropriate hashtags for better visibility #️⃣
- Get Credits for writing 🫵
- Increase your chance to get noticed in the community
- Show this as a proof of work for your next content-writing job
- SEO-friendly
- light & dark mode
- fuzzy search
- dynamic OG image generation for blog posts
- Complete MD support
Inside of Web3sec.News, you'll see the following folders and files:
/
├── public/
│ ├── assets/
│ │ └── logo.svg
│ │ └── logo.png
│ └── favicon.ico
│ └── og.png
│ └── robots.txt
│ └── toggle-theme.js
├── src/
│ ├── assets/
│ │ └── socialIcons.ts
│ ├── components/
│ ├── content/
│ │ | blog/
│ │ | └── some-blog-posts.md
│ │ └── _schemas.ts
│ │ └── config.ts
│ ├── layouts/
│ └── pages/
│ └── styles/
│ └── utils/
│ └── config.ts
│ └── types.ts
└── package.jsonWeb3sec.news looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.
Any static assets, like images, can be placed in the public/ directory.
All blog posts are stored in src/content/blog directory.
To get started, make sure you have the following:
- An account on GitHub. If you don't have one, you can sign up for free.
- Basic knowledge of Markdown syntax. If you're new to Markdown, check out this Markdown Cheatsheet to get familiar with the syntax.
Follow these steps to write and submit your blog:
-
Fork the Repository: Visit the Web3sec.News Blog repository and click on the "Fork" button in the top-right corner of the page. This action will create a copy of the repository under your GitHub account.
-
Clone the Forked Repository: On your GitHub profile, locate the forked repository (
yourusername/blog). Click on the "Code" button and copy the repository's URL. Open your preferred command-line interface, navigate to a directory where you want to store the repository, and execute the following command:git clone <repository-url> -
Create a New Branch: Change to the repository's directory by running
cd blog. Create a new branch for your blog using the following command:git checkout -b my-blogReplace
my-blogwith a descriptive branch name related to your blog content. -
Write Your Blog : Inside the cloned repository, navigate to the
blogsdirectory. Create a new Markdown file with a meaningful name for your blog (e.g.,my-blog.md). Use any text editor to write your blog using Markdown syntax. You can refer to the aforementioned Markdown Cheatsheet for assistance.Here is the list of
Mandatoryproperty for each post.Property Description Remark title Title of the post. (h1) required* author Author of the post default = SITE.author description Description of the post. Used in post excerpt and site description of the post. required* pubDatetime Published datetime in ISO 8601 format. required* tags Related keywords for this post. Written in array yaml format. default = others -
Only
title,descriptionandpubDatetimefields in frontmatter must be specified. -
Title and description (excerpt) are important for search engine optimization (SEO) and thus Web3sec.News encourages to include these in blog posts.
-
If you omit
tagsin a blog post (in other words, if no tag is specified), the default tagotherswill be used as a tag for that post.
Here is the sample frontmatter for a blog post.
# src/content/blog/sample-post.md --- title: How to Submit a blog author: Web3sec.News pubDatetime: 2023-06-04T05:17:19Z tags: - web3sec - smart contracts - hacks description: This is the example description of the example post. ---
-
-
Add Credits: At the end of your blog, make sure to include appropriate credits to yourself as the writer. Add a section with your name or preferred credit information. For example:
**About the Writer** - Name: Your Name - Website: Your Website (optional) - GitHub: [@your-username](https://github.com/your-username) - Twitter: [@your-handle](https://twitter.com/your-handle) (optional) -
Save Your Changes: After writing and adding credits, save the file.
-
Commit and Push: In your command-line interface, run the following commands to commit and push your changes:
git add blogs/my-blog.md git commit -m "Add my blog: My Blog Title" git push origin my-blog -
Submit a Pull Request: Once you've pushed your changes to your forked repository, navigate to the original Web3sec.News Blog repository on GitHub. You should see a banner with a message stating that your recently pushed branch has differences. Click on the "Compare & pull request" button.
-
Review and Submit: On the PR page, you can review the changes you made. Provide a descriptive title and description for your PR, summarizing your blog's content. Once you're satisfied, click on the "Create pull request" button.
Congratulations! You've successfully submitted your blog for review and publishing
If you have any suggestions/feedback, you can contact me via my email. Alternatively, feel free to open an issue if you find bugs or want to request new features.
Patrick Collins, CEO Cyfrin Audit & Audit Wizard
Made with 🤍 by Chirag Agrawal 👨🏻💻