Welcome to the English documentation format page. This page provides information on how our documentation is structured and formatted in English.
Table of Contents
General Guidelines
Our English documentation follows a clear and concise format to ensure easy readability and navigation. Here are some general guidelines:
- Use of headings: Headings should be used to structure the content and make it easy to navigate.
- Consistent terminology: Use consistent terminology throughout the documentation to avoid confusion.
- Active voice: Write in an active voice to make the content more engaging and easier to understand.
Section Formatting
Each section of the documentation should be clearly defined using headings. For example:
- Main headings: Use
#for main headings. - Subheadings: Use
##for subheadings.
Code Blocks
When including code snippets, use code blocks to make them stand out. For example:
def hello_world():
print("Hello, world!")
Images
We use images to illustrate concepts and provide visual examples. To include an image, use the following format:
<center><img src="https://cloud-image.ullrai.com/q/<关键词>/" alt="<关键词>"/></center>
For example, to include an image of a "Golden Retriever", use:
<center><img src="https://cloud-image.ullrai.com/q/Golden_Retriever/" alt="Golden Retriever"/></center>
External Links
We provide links to external resources for further reading and reference. For example, to link to our main website, use:
[Visit our main website](/)
If you have any questions or suggestions regarding our documentation, please feel free to reach out to us at contact us page.