Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hoowc/techdocs

Provides learning platforms for various programming languages
https://github.com/hoowc/techdocs

css html javascript json md pnpm react theme typescript

Last synced: about 1 month ago
JSON representation

Provides learning platforms for various programming languages

Awesome Lists containing this project

README

        


Learning Platform






## ๐Ÿ‘‹ Introduce

Here, I will share with you the various problems I encountered during the technical development process and my experience and solutions on how to solve them. From front-end development to back-end debugging, from database optimization to exception handling of API requests, I will discuss common technical problems and solutions with you in an easy-to-understand way. I hope that these sharings can not only help you avoid common pitfalls, but also provide some practical guidance for your technical growth.

---------------------------

ๅœจ่ฟ™้‡Œ๏ผŒๆˆ‘ๅฐ†ไธŽๅคงๅฎถๅˆ†ไบซๆˆ‘ๅœจๆŠ€ๆœฏๅผ€ๅ‘่ฟ‡็จ‹ไธญ้‡ๅˆฐ็š„ๅ„็ง้—ฎ้ข˜ไปฅๅŠๆˆ‘ๅฆ‚ไฝ•่งฃๅ†ณๅฎƒไปฌ็š„็ป้ชŒๅ’Œๆ–นๆกˆใ€‚ไปŽๅ‰็ซฏๅผ€ๅ‘ๅˆฐๅŽ็ซฏ่ฐƒ่ฏ•๏ผŒไปŽๆ•ฐๆฎๅบ“ไผ˜ๅŒ–ๅˆฐAPI่ฏทๆฑ‚็š„ๅผ‚ๅธธๅค„็†๏ผŒๆˆ‘ไผš็”จ่ฝปๆพๆ˜“ๆ‡‚็š„ๆ–นๅผๅ’Œๅคงๅฎถไธ€่ตทๆŽข่ฎจๅธธ่ง็š„ๆŠ€ๆœฏ้šพ้ข˜ๅ’Œ่งฃๅ†ณๆ–นๆณ•ใ€‚ๅธŒๆœ›่ฟ™ไบ›ๅˆ†ไบซไธไป…่ƒฝๅธฎๅŠฉไฝ ้ฟๅ…ๅธธ่ง็š„ๅ‘๏ผŒ่ฟ˜่ƒฝไธบไฝ ็š„ๆŠ€ๆœฏๆˆ้•ฟๆไพ›ไธ€ไบ›ๅฎž็”จ็š„ๆŒ‡ๅฏผใ€‚

## โœจ Characteristic

- ๐Ÿฆ– **Docusaurus** - Based on Docusaurus, provides powerful document generation and blogging functions
- โœ๏ธ **Markdown** - Easy to write, Markdown/Typora
- ๐ŸŽจ **Beautiful** - Neat, beautiful, reading experience first
- ๐Ÿ–ฅ๏ธ **PWA** - Supports PWA, installable, available offline
- ๐ŸŒ **i18n** - Supports internationalization
- ๐Ÿ’ฏ **SEO** - Search engine optimization, easy to include
- ๐Ÿ“Š **Google Analytics** - Supports Google Analytics
- ๐Ÿ”Ž **Full text search** - Convenient to search for articles
- ๐Ÿš€ **Continuous Integration** - Supports CI/CD, automatically deploys updated content
- ๐Ÿž๏ธ **Home View** - Displays the latest blog posts, project displays, personal characteristics, technology stacks, etc.
- ๐Ÿ—ƒ๏ธ **Blog View** - Different blog post views, lists, grids
- ๐ŸŒˆ **Resource Navigation** - Collect and share useful and interesting resources
- ๐Ÿ“ฆ **Project Display** - Show your projects, which can be used as a portfolio

## :wrench: Technology Stack

- Docusaurus
- TailwindCSS
- React
- Json
- JavaScript
- TypeScript
- NextJS
- Framer motion & magicui

## ๐Ÿ“Š Directory Structure

```bash
โ”œโ”€โ”€ blog # Blog
โ”‚ โ”œโ”€โ”€ first-blog.md
โ”œโ”€โ”€ docs # Documents/notes
โ”‚ โ””โ”€โ”€ doc.md
โ”œโ”€โ”€ data
โ”‚ โ”œโ”€โ”€ feature.tsx # Features
โ”‚ โ”œโ”€โ”€ projects.tsx # Projects
โ”‚ โ”œโ”€โ”€ skills.tsx # Technology stack
โ”‚ โ”œโ”€โ”€ resources.tsx # Resources
โ”‚ โ””โ”€โ”€ social.ts # Social links
โ”œโ”€โ”€ i18n # Internationalization
โ”œโ”€โ”€ src
โ”‚ โ”œโ”€โ”€ components # Components
โ”‚ โ”œโ”€โ”€ css # Custom CSS
โ”‚ โ”œโ”€โ”€ pages # Custom pages
โ”‚ โ”œโ”€โ”€ plugin # Custom plugins
โ”‚ โ””โ”€โ”€ theme # Custom theme components
โ”œโ”€โ”€ static # Static resource files
โ”‚ โ””โ”€โ”€ img # Static images
โ”œโ”€โ”€ docusaurus.config.ts # Site configuration information
โ”œโ”€โ”€ sidebars.ts # Document sidebar
โ”œโ”€โ”€ package.json
โ”œโ”€โ”€ tsconfig.json
โ””โ”€โ”€ pnpm-lock.yaml
```

## ๐Ÿ“ฅ Run

```Bash
git clone https://github.com/your-git-link
cd blog
pnpm install
pnpm start / pnpm run serve
```

Build

```bash
pnpm build
```

## ๐Ÿ“ License

[MIT](./LICENSE)