Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: rebuild tutorial #5

Merged
merged 3 commits into from
Dec 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,25 +1,15 @@
# Node modules
**/node_modules/**

# Build files
docs-shared/lib/
packages/*/lib/

# Vuepress Cache
**/.vuepress/.cache/**
# Vuepress Temp
**/.vuepress/.temp/**
# Vuepress Output
#dist/
**/.vuepress/dist/

# npm config
.npmrc

# Typescript build info
*.tsbuildinfo

# Coverage Files
coverage/

# macOS
.DS_Store
9 changes: 9 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Node modules
**/node_modules/**

# Vuepress Cache
**/.vuepress/.cache/**
# Vuepress Temp
**/.vuepress/.temp/**
# Vuepress Output
**/.vuepress/dist/
7 changes: 7 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,16 @@
"docs:build": "vuepress build src",
"docs:clean-dev": "vuepress dev src --clean-cache",
"docs:dev": "vuepress dev src",
"docs:lint": "prettier --check --write src",
"docs:update-package": "npx vp-update"
},
"packageManager": "[email protected]",
"prettier": {
"singleQuote": false
},
"dependencies": {
"prettier": "^3.1.0"
},
"devDependencies": {
"@vuepress/bundler-vite": "2.0.0-rc.0",
"@vuepress/client": "2.0.0-rc.0",
Expand Down
11 changes: 11 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 22 additions & 22 deletions src/.vuepress/navbar/en.ts
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
import {navbar} from "vuepress-theme-hope";
import { navbar } from "vuepress-theme-hope";

export const enNavbar = navbar([
"/",
"/guide/",
"/tutorial/",
{
text: "Reference",
icon: "lightbulb",
prefix: "/reference/",
children: ["test",
"resources",
"documents",
"development_log"
],
},
{
text: "More",
icon: "lightbulb",
prefix: "/more/",
children: [
"collaborative_projects", 'license', 'thanks', "contact", "use_cases"
],
},
"/",
"/guide/",
"/tutorial/",
{
text: "Reference",
icon: "lightbulb",
prefix: "/reference/",
children: ["test", "resources", "documents", "development_log"],
},
{
text: "More",
icon: "lightbulb",
prefix: "/more/",
children: [
"collaborative_projects",
"license",
"thanks",
"contact",
"use_cases",
],
},
]);
43 changes: 22 additions & 21 deletions src/.vuepress/navbar/zh.ts
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
import {navbar} from "vuepress-theme-hope";
import { navbar } from "vuepress-theme-hope";

export const zhNavbar = navbar([
"/zh/",
"/zh/guide/",
"/zh/tutorial/",
{
text: "参考",
icon: "lightbulb",
prefix: "/zh/reference/",
children: ["test",
"resources",
"documents", "development_log"
],
},
{
text: "了解更多",
icon: "laptop-code",
prefix: "/zh/more/",
children: [
"collaborative_projects", 'license', 'thanks', "contact", "use_cases"
],
},
"/zh/",
"/zh/guide/",
"/zh/tutorial/",
{
text: "参考",
icon: "lightbulb",
prefix: "/zh/reference/",
children: ["test", "resources", "documents", "development_log"],
},
{
text: "了解更多",
icon: "laptop-code",
prefix: "/zh/more/",
children: [
"collaborative_projects",
"license",
"thanks",
"contact",
"use_cases",
],
},
]);
49 changes: 25 additions & 24 deletions src/.vuepress/sidebar/en.ts
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
import {sidebar} from "vuepress-theme-hope";
import { sidebar } from "vuepress-theme-hope";

export const enSidebar = sidebar({
"/": [
"",
"tutorial/",
{
text: "Docs",
icon: "book",
prefix: "guide/",
children: "structure",
}, {
text: "Reference",
icon: "laptop-code",
prefix: "reference/",
link: "reference/",
children: "structure",
},
{
text: "More",
icon: "laptop-code",
prefix: "more/",
link: "more/",
children: "structure",
},
],
"/": [
"",
"tutorial/",
{
text: "Docs",
icon: "book",
prefix: "guide/",
children: "structure",
},
{
text: "Reference",
icon: "laptop-code",
prefix: "reference/",
link: "reference/",
children: "structure",
},
{
text: "More",
icon: "laptop-code",
prefix: "more/",
link: "more/",
children: "structure",
},
],
});
49 changes: 25 additions & 24 deletions src/.vuepress/sidebar/zh.ts
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
import {sidebar} from "vuepress-theme-hope";
import { sidebar } from "vuepress-theme-hope";

export const zhSidebar = sidebar({
"/zh/": [
"",
"tutorial/",
{
text: "指南",
icon: "book",
prefix: "guide/",
children: "structure",
}, {
text: "参考",
icon: "laptop-code",
prefix: "reference/",
link: "reference/",
children: "structure",
},
{
text: "了解更多",
icon: "laptop-code",
prefix: "more/",
link: "more/",
children: "structure",
},
],
"/zh/": [
"",
"tutorial/",
{
text: "指南",
icon: "book",
prefix: "guide/",
children: "structure",
},
{
text: "参考",
icon: "laptop-code",
prefix: "reference/",
link: "reference/",
children: "structure",
},
{
text: "了解更多",
icon: "laptop-code",
prefix: "more/",
link: "more/",
children: "structure",
},
],
});
9 changes: 5 additions & 4 deletions src/.vuepress/styles/index.scss
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
.vp-hero-info-wrapper {
width:100vw;
width: 100vw;
background: url(/assets/image/bg.svg) center/cover no-repeat;
}

@media (min-width: 768px) {
.vp-hero-info-wrapper {
height:100vh
}
.vp-hero-info-wrapper {
height: 100vh;
}
}
1 change: 1 addition & 0 deletions src/.vuepress/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export default hopeTheme({
imgLazyload: true,
imgSize: true,
mermaid: true,
tabs: true,
},

// uncomment these if you want a pwa
Expand Down
27 changes: 8 additions & 19 deletions src/guide/install/install_zlmediakit_using_vcpkg.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
title: Installing zlmediakit with vcpkg
---

# Introduction
vcpkg is a cross-platform SDK package management tool, similar to yum/apt on Linux and Homebrew on macOS. It supports multiple platforms such as Linux, macOS, and Windows, making it a powerful tool for C/C++ developers to manage dependencies.
## Introduction

vcpkg is a cross-platform SDK package management tool, similar to yum/apt on Linux and Homebrew on macOS. It supports multiple platforms such as Linux, macOS, and Windows, making it a powerful tool for C/C++ developers to manage dependencies.
Currently, zlmediakit has been added to vcpkg on August 8, 2023. Users can conveniently install zlmediakit C SDK and MediaServer executable program using vcpkg, resolving various compilation dependency-related issues. The inclusion of zlmediakit in vcpkg has received extensive support from [@JackBoosY](https://github.com/JackBoosY), and we express our sincere gratitude for that!

# Installation Guide
## Installation Guide

## 1. Install vcpkg

Taking Linux platform as an example:
Expand All @@ -20,8 +22,6 @@ git clone https://github.com/microsoft/vcpkg

> For specific instructions on different platforms, please refer to the [official documentation](https://github.com/microsoft/vcpkg/blob/master/README.md).



## 2. Install zlmediakit

- Install dependencies first
Expand All @@ -30,42 +30,34 @@ git clone https://github.com/microsoft/vcpkg
sudo apt-get install pkg-config
```



- Install zlmediakit with default features

```bash
# Default features enabled: [core,mp4,openssl,webrtc]
./vcpkg/vcpkg install zlmediakit
```



- Install zlmediakit with all features (including webrtc datachannel)

```bash
./vcpkg/vcpkg install zlmediakit\[core,mp4,openssl,webrtc,sctp\]
```



- Install zlmediakit with minimum features

```bash
./vcpkg/vcpkg install zlmediakit\[core\]
```



- Uninstall zlmediakit

```bash
./vcpkg/vcpkg remove zlmediakit
```

- Installation path
![](/images/install_zlmediakit_using_vcpkg_1.png)
> The MediaServer process depends on config.ini, default.pem, www, and other related files, which can be copied from the source code.
![](/images/install_zlmediakit_using_vcpkg_1.png)
> The MediaServer process depends on config.ini, default.pem, www, and other related files, which can be copied from the source code.

## 3. Install different versions

Expand All @@ -75,8 +67,6 @@ git clone https://github.com/microsoft/vcpkg
./vcpkg/vcpkg help triplet
```



- Example for Linux

```bash
Expand Down Expand Up @@ -111,6 +101,5 @@ git clone https://github.com/microsoft/vcpkg
# Then install the dynamic library version
./vcpkg/vcpkg install zlmediakit\[core,mp4,openssl,webrtc,sctp\]:x64-linux-dynamic
```
![install_zlmediakit_using_vcpkg_2](/images/install_zlmediakit_using_vcpkg_2.png)


![install_zlmediakit_using_vcpkg_2](/images/install_zlmediakit_using_vcpkg_2.png)
Loading