Browse Source

Rewrite introduction

Felix Sun 1 year ago
parent
commit
4c3d169e90
3 changed files with 22 additions and 9 deletions
  1. 0 0
      docs/search_indexes.json
  2. 1 1
      docs/seo.html
  3. 21 8
      docsrc/content/home.go

File diff suppressed because it is too large
+ 0 - 0
docs/search_indexes.json


+ 1 - 1
docs/seo.html

@@ -290,7 +290,7 @@ Customization</h2>
 <p>You can customize your SEO settings by implementing the interface and adding functions such as l10n and publish.</p>
 
 <highlightjs :language='"go"' :code='"type QorSEOSettingInterface interface {\n\tGetName() string\n\tSetName(string)\n\tGetSEOSetting() Setting\n\tSetSEOSetting(Setting)\n\tGetVariables() Variables\n\tSetVariables(Variables)\n\tGetTitle() string\n\tGetDescription() string\n\tGetKeywords() string\n\tGetOpenGraphURL() string\n\tGetOpenGraphType() string\n\tGetOpenGraphImageURL() string\n\tGetOpenGraphImageFromMediaLibrary() media_library.MediaBox\n\tGetOpenGraphMetadata() []OpenGraphMetadata\n}\n"'></highlightjs>
-<p>Suppose <code>QorSEOSetting</code> implemented the above interface</p>
+<p>Suppose <code>MySEOSetting</code> implemented the above interface</p>
 
 <div class="highlight highlight-go"><pre>type MySEOSetting struct{
 		QorSEOSetting

+ 21 - 8
docsrc/content/home.go

@@ -8,21 +8,34 @@ import (
 
 var Home = Doc(
 	Markdown(`
-QOR5 is a Go library to build web applications. We aim to accelerate the development speed and make the website highly customizable.
+QOR5 is a Go library designed to help developers build web applications with ease and high customization. By focusing on static typing in the Go language and minimizing the need for JavaScript or TypeScript, QOR5 streamlines the development process and encourages reusability of components.
+
+In QOR5, the traditional approach of using template languages for rendering HTML is discouraged. Instead, QOR5 encourages developers to write HTML [using static typing in the Go language](/advanced-functions/the-go-html-builder.html). This design choice provides several benefits:
+
+- Improved Readability and Maintainability: By using Go's static typing, you can maintain a consistent coding style throughout the entire project, making it easier to read and maintain.
+
+- Better Error Checking: Static typing allows for compile-time error checking, which can help catch issues before they cause problems in production.
+
+- Enhanced Reusability: QOR5 promotes the use of components, which can be easily abstracted and reused across different parts of your application. Since components are written in Go, using third-party components from other Go packages is as simple as importing and using regular Go packages.
+
+- Simplified Development Process: By minimizing the need for JavaScript or TypeScript, QOR5 streamlines the development process and reduces the complexity of building interactive web applications.
+
+QOR5's approach to rendering HTML using Go's static typing eliminates the need for developers to learn and work with multiple template languages. This results in a more consistent and streamlined development experience, allowing developers to focus on the core functionality of their web applications.
 
-- It prefers writing HTML in [static typing Go language](/advanced-functions/the-go-html-builder.html), rather than a certain type of template language, Not even go template.
-- It try to minify the needs to write any JavaScript/Typescript for building interactive web applications
-- It maximize the reusability of Components. since it uses Go to write components, You can abstract component very easy, and use component from a third party Go package is also like using normal Go packages.
 	`),
 
 	utils.Anchor(H2(""), "How is this document organized"),
 	Markdown(`
 Most of latter examples are based on the initial sample project. In another word, we will demonstrate how to build a rich functioned website by this document.
 
-- First, we will start with a quick sample project that would give you a rough but visual idea of what QOR5 can do.
-- Second, we will introduce the basic functions, The sequence is from listing page to editing page. You can find all commonly used Admin website features in this section.
-- Third, we will introduce the essentials of QOR5 and advanced functions, You would understand how QOR5 render a page and advanced features like "how to partially refresh a page".
-- At last, the digging deeper part, you would learn how to create new component for QOR5
+- Quick Sample Project: We will begin with a brief overview of a sample project, giving you a visual idea of QOR5's capabilities and functionalities.
+
+- Basic Functions: In this section, we will explore the core features of QOR5, starting from listing pages to editing pages. This section covers common features found in admin websites.
+
+- QOR5 Essentials and Advanced Functions: We will dive into the inner workings of QOR5, covering topics such as rendering pages and advanced features like partial page refreshing.
+
+- Digging Deeper: In the final section, you will learn how to create new components for QOR5, extending its capabilities and adapting it to your specific needs.
+
 
 **Join the Discord community**: https://discord.gg/76YPsVBE4E
 `)).Title("Introduction").

Some files were not shown because too many files changed in this diff