Skip to content

Blog Writing guideliness #1483

@sanjay-kv

Description

@sanjay-kv

Discussed in #1482

Originally posted by sanjay-kv May 12, 2026
These are the few things we should follow on every blog content.
Note : Blog content is different from the technical documentation.

  • 5 backlink to different website to support our documentation.

  • 5 inside backlink to other article in recodehive.

  • No generic content, like what is Azure , difference between this and that. pure high depth techinical article with images
    eg: https://www.recodehive.com/docs/GitHub/Maintainer-guide/milestone
    This article i used snagit software to make it easy.

  • Make sure image u upload has proper name, no random names, it helps with SEO.

  • code to text ratio should be considered. adsense flag is 60%code and 40%text it should be opposite. more code redirect to github and mention in comment section.

  • always follow these kinda of bulleted summary section on the top of blog

image -[ ] lets have faq section - [ ] lets have these format when mentioned code relevance. explaining what code it is like sample.java image
# Git-Demo
This is a demo installation via GUI

## Developed by Sanjay Viswanathan
This readme contains my resume, please refer to the attached file in the repo.

-[ ] Lets use this format when using screenshot
image

`
<>

Git-Demo


This is a demo installation via GUI

<h1>Developed by Sanjay Viswanathan</h1>
<p>This readme contains my resume, please refer to the attached file in the repo.</p>

</>

`

  • lfor any extra note or caution while using can add the blue layer
image

:::info In the picture below, you can see Developer 1, Developer 2, etc., working on the same project. Let's say they are trying to build an Amazon website; Developer 1 handles the men's shopping section, Developer 2 deals with the women's section, and Developer 3 works on the login feature.

  • table should be center aligned, to achieve this put it inside info section docusaurus
image image
  • [ ]provide tips using
image image

:::tip Need Git Commands? Want to start using Git right away? Check out our [comprehensive Git Commands Cheatsheet](../GitHub/setup-environment/git-commands.md) that includes 50 essential Git commands with examples. We also recommend trying [Learn Git Branching](https://learngitbranching.js.org/) - an interactive visual tool to practice Git commands in a gamified environment! :::

  • [ ]can also use note like this
image

`:::note
Key Features of GitLab:

  • GitLab is not only a Git-based repository management tool but also provides built-in CI/CD pipelines.
  • Unlike GitHub, GitLab can be self-hosted as well as used on the cloud (GitLab.com).
  • GitLab offers Premium Plans with advanced CI/CD, security, compliance, and scalability features.
    :::`

if using query and ouptut should use this single window.

image ` :::info ```sql title="Friends" | id | name | username | |----|-----------------|------------------| | 1 | John Doe | @johndoe | | 2 | Jane Smith | @JaneSmith | | 3 | Bob Johnson | @BOBJohnson | ```
  -- creating database
  CREATE DATABASE my_database;

  -- use the database you created
  USE my_database;


-- Create the table
CREATE TABLE friends (
  id INT PRIMARY KEY,
  name VARCHAR(100),
  username VARCHAR(100)
);

-- Insert data into the table
INSERT INTO friends (id, name, username) VALUES
(1, 'John Doe', '@johndoe'),
(2, 'Jane Smith', '@janesmith'),
(3, 'Bob Johnson', '@bobjohnson');

  ```

  </TabItem>
  
  <TabItem value="how-git-works" label="Output ">
    | id | name            | username         |
|----|-----------------|------------------|
| 1  | John Doe        | @johndoe         |
| 2  | Jane Smith      | @janesmith       |
| 3  | Bob Johnson     | @bobjohnson      |
  </TabItem>
</Tabs>


:::`
@Adez017 

by considering this can you update this documentation part. 
this is not part of paid blogs. 

https://www.recodehive.com/docs/Getting-Started

this helps other contributor to do more quality articles. </div>

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationlevel 110 pointsrecodethis is label for leaderboard

Type

No fields configured for Bug.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions