mirror of
				https://github.com/XRPLF/xrpl-dev-portal.git
				synced 2025-11-04 11:55:50 +00:00 
			
		
		
		
	Contribution guidelines for blog posts
This commit is contained in:
		@@ -4,6 +4,7 @@ ignore:
 | 
			
		||||
  - _code-samples/*/README.md
 | 
			
		||||
  - _code-samples/**/README.md
 | 
			
		||||
  - _code-samples/create-amm/ts/tsconfig.json
 | 
			
		||||
  - resources/contribute-blog/_blog-template.md
 | 
			
		||||
l10n:
 | 
			
		||||
  defaultLocale: en-US
 | 
			
		||||
  locales:
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										54
									
								
								resources/contribute-blog/_blog-template.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										54
									
								
								resources/contribute-blog/_blog-template.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,54 @@
 | 
			
		||||
---
 | 
			
		||||
category: 2025
 | 
			
		||||
date: 2025-mm-dd
 | 
			
		||||
seo:
 | 
			
		||||
    title: SEO optimized title under 50chars
 | 
			
		||||
    description: SEO optimized description for the blog post that can be displayed in search results.
 | 
			
		||||
 | 
			
		||||
labels:
 | 
			
		||||
    - General
 | 
			
		||||
markdown:
 | 
			
		||||
    editPage:
 | 
			
		||||
        hide: true
 | 
			
		||||
---
 | 
			
		||||
# SEO optimized title under 50chars (Recommend keeping it same as the meta title above for consistency)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Congrats on taking the first step toward drafting your blog post! Use this template as a starting point to organize your blog post.
 | 
			
		||||
 | 
			
		||||
<!-- BREAK -->
 | 
			
		||||
 | 
			
		||||
Refer to the [Contributing Guide](https://xrpl.org/resources/contribute-documentation) for detailed guidelines and examples.
 | 
			
		||||
 | 
			
		||||
## Section: Handy Reference
 | 
			
		||||
 | 
			
		||||
To help you get started quickly, here’s a handy guide to the syntax for some of the most frequently used components in a blog post — perfect for streamlining your writing process.
 | 
			
		||||
 | 
			
		||||
To include an internal link, use a relative path.  For example, here's a link to the [Contributing Guide](../resources/contribute-documentation/index.md).
 | 
			
		||||
 | 
			
		||||
To include an external link, use the absolute URL instead of a relative path. For example, [Contributing Guide](https://xrpl.org/resources/contribute-documentation).
 | 
			
		||||
 | 
			
		||||
To include an unordered list, use the following syntax:
 | 
			
		||||
 | 
			
		||||
- Item 1
 | 
			
		||||
- Item 2
 | 
			
		||||
 | 
			
		||||
To include an ordered list, use the following syntax:
 | 
			
		||||
 | 
			
		||||
1. List item 1
 | 
			
		||||
2. List item 2
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### Sub-section: Including Images In Your Blog Post
 | 
			
		||||
 | 
			
		||||
To include an image, use the following syntax:
 | 
			
		||||
 | 
			
		||||
Store your graphics in the `/blog/img` directory. Embed graphics using the syntax:
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
For example,  renders as follows.
 | 
			
		||||
 | 
			
		||||
### Sub-section: Embedding Videos In Your Blog Post
 | 
			
		||||
 | 
			
		||||
For instructions to embed a video, refer to the [Contribution Guide](https://xrpl.org/resources/contribute-documentation#videos).
 | 
			
		||||
							
								
								
									
										39
									
								
								resources/contribute-blog/index.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										39
									
								
								resources/contribute-blog/index.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,39 @@
 | 
			
		||||
---
 | 
			
		||||
html: contribute-blog.html
 | 
			
		||||
parent: resources.html
 | 
			
		||||
seo:
 | 
			
		||||
    description: Contribution guide for XRPL Blog.
 | 
			
		||||
labels:
 | 
			
		||||
  - Blockchain
 | 
			
		||||
---
 | 
			
		||||
# Contribute a Blog Post
 | 
			
		||||
 | 
			
		||||
Thanks for considering a contribution to the XRP Ledger Dev Blog!
 | 
			
		||||
 | 
			
		||||
This page includes high-level instructions to create a new blog post. Detailed instructions and guidelines to contribute to the XRPL Developer Portal are available in [Contributing Documentation](../contribute-documentation/index.md).
 | 
			
		||||
 | 
			
		||||
## Directory Structure for Blog Posts
 | 
			
		||||
 | 
			
		||||
The source files are located in the `blog` directory of the public `xrpl-dev-portal` repository. 
 | 
			
		||||
 | 
			
		||||
The image files used in blog posts are located in the `blog/img` directory.
 | 
			
		||||
 | 
			
		||||
The blog posts are grouped by year, so all blog posts published in year 2025 will be located in the `blog/2025` directory. 
 | 
			
		||||
 | 
			
		||||
## Steps to Create a New Blog Post
 | 
			
		||||
 | 
			
		||||
To create a new post, follow these steps:
 | 
			
		||||
 | 
			
		||||
1. Before you begin, ensure that you pull the most recent updates from the upstream `master` branch of the `xrpl-dev-portal` repository.
 | 
			
		||||
 | 
			
		||||
2. Create a new branch for the blog post using the format `blog-<short-desc-of-update>`.
 | 
			
		||||
 | 
			
		||||
3. Create a new markdown file in the `blog/_current_year_` folder, for example https://github.com/XRPLF/xrpl-dev-portal/tree/master/blog/2025
 | 
			
		||||
 | 
			
		||||
4. Refer to the template file `_blog_template.md` to compose your draft blog. 
 | 
			
		||||
 | 
			
		||||
5. Update the `blog/sidebar.yaml` file to include the newly created file.
 | 
			
		||||
 | 
			
		||||
6. Once the draft is ready for review, save and commit your updates.
 | 
			
		||||
 | 
			
		||||
7. Create a new PR to merge your changes to master. 
 | 
			
		||||
		Reference in New Issue
	
	Block a user