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

[TEST] Try markdown-it-block-embed for video embed #3294

Merged
merged 3 commits into from
Jul 17, 2024
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
10 changes: 2 additions & 8 deletions .vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { defineConfig } from "vitepress";
const getSidebar = require("./get_sidebar.js");
//import { getSidebar } from "./get_sidebar";

import markdownItVideo from "markdown-it-video";
import blockEmbedPlugin from "markdown-it-block-embed";
// Tabs: https://github.com/Red-Asuka/vitepress-plugin-tabs
import tabsPlugin from "@red-asuka/vitepress-plugin-tabs";

Expand All @@ -26,15 +26,9 @@ export default defineConfig({
ignoreDeadLinks: true,
markdown: {
math: true,

// container: {
// tipLabel: "Note",
// },

config: (md) => {
// use more markdown-it plugins!
md.use(markdownItVideo);

md.use(blockEmbedPlugin);
tabsPlugin(md); //https://github.com/Red-Asuka/vitepress-plugin-tabs
},
},
Expand Down
8 changes: 6 additions & 2 deletions en/concept/flight_tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,15 @@ The second is an update, which covers the changes in PX4 v1.11.

A description of how flight modes work in PX4 v1.9 (Dennis Mannhart, Matthias Grob).

@[youtube](https://youtu.be/-dkQG8YLffc) <!-- datestamp:video:youtube:20190704:PX4 Flight Task Architecture Overview — PX4 Developer Summit 2019 -->
@[youtube](https://youtu.be/-dkQG8YLffc)

<!-- datestamp:video:youtube:20190704:PX4 Flight Task Architecture Overview — PX4 Developer Summit 2019 -->

### Overview of multicopter control from sensors to motors (PX4 Developer Summit Virtual 2020)

@[youtube](https://youtu.be/orvng_11ngQ?t=560) <!-- datestamp:video:youtube:20200720:Overview of multicopter control from sensors to motors — PX4 Developer Summit Virtual 2020 From 9min20sec - Section on flight tasks-->
@[youtube](https://youtu.be/orvng_11ngQ?t=560)

<!-- datestamp:video:youtube:20200720:Overview of multicopter control from sensors to motors — PX4 Developer Summit Virtual 2020 From 9min20sec - Section on flight tasks-->

The relevant section of this video is an update of flight tasks in PX4 v11.1 at (9min 20sec).
The [slides can be found here (PDF)](https://static.sched.com/hosted_files/px4developersummitvirtual2020/1b/PX4%20Developer%20Summit%202020%20-%20Overview%20of%20multicopter%20control%20from%20sensors%20to%20motors.pdf) - Slides 9 and 12 are relevant.
1 change: 1 addition & 0 deletions en/config/flight_mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ The video below shows how this is done with the *FrSky Taranis* transmitter.

<!-- [youtube](https://youtu.be/scqO7vbH2jo) Video has gone private and is no longer available -->
<!-- @[youtube](https://youtu.be/BNzeVGD8IZI?t=427) - video showing how to set the QGC side - at about 7mins and 3 secs -->

@[youtube](https://youtu.be/TFEjEQZqdVA)

The *QGroundControl* configuration is then [as described above](#flight-mode-selection).
Expand Down
2 changes: 1 addition & 1 deletion en/contribute/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ When you add a new page you must also add it to `en/SUMMARY.md`!

4. Videos:

- Youtube videos can be added using the format `@[youtube](https://youtu.be/<youtube-video-id>)` (supported via the [markdown-it-video](https://www.npmjs.com/package/markdown-it-video) plugin).
- Youtube videos can be added using the format `@[youtube](https://youtu.be/<youtube-video-id>)` (supported via the [markdown-it-block-embed](https://www.npmjs.com/package/markdown-it-block-embed) plugin).
- Use instructional videos sparingly as they date badly, and are hard to maintain.
- Cool videos of airframes in flighyt are always welcome.

Expand Down
16 changes: 12 additions & 4 deletions en/sim_airsim/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ See [Toolchain Installation](../dev_setup/dev_env.md) for information about the
[AirSim](https://microsoft.github.io/AirSim/) is a open-source, cross platform simulator for drones, built on _Unreal Engine_.
It provides physically and visually realistic simulations of Pixhawk/PX4 using either Hardware-In-The-Loop (HITL) or Software-In-The-Loop (SITL).

@[youtube](https://youtu.be/-WfTr1-OBGQ) <!-- datestamp:video:youtube:20170216:AirSim Demo -->
@[youtube](https://youtu.be/-WfTr1-OBGQ)

<!-- datestamp:video:youtube:20170216:AirSim Demo -->

## PX4 Setup

Expand All @@ -20,7 +22,9 @@ It provides physically and visually realistic simulations of Pixhawk/PX4 using e

#### AirSim with PX4 on WSL 2

@[youtube](https://youtu.be/DiqgsWIOoW4) <!-- datestamp:video:youtube:20210401:AirSim with PX4 on WSL 2 -->
@[youtube](https://youtu.be/DiqgsWIOoW4)

<!-- datestamp:video:youtube:20210401:AirSim with PX4 on WSL 2 -->

::: info
WSL 2 is not a supported [PX4 Windows development environment](../dev_setup/dev_env_windows_cygwin.md), mainly because it is non-trivial to display simulator UIs running within WSL 2 in the normal Windows environment.
Expand All @@ -29,11 +33,15 @@ This limitation does not apply for AirSim because its UI is run natively in Wind

#### Microsoft AirSim: Applications to Research and Industry (PX4 Developer Summit Virtual 2020)

@[youtube](https://youtu.be/-YMiKaJYl44) <!-- datestamp:video:youtube:20200716:Microsoft AirSim: Applications to Research and Industry — PX4 Developer Summit Virtual 2020 -->
@[youtube](https://youtu.be/-YMiKaJYl44)

<!-- datestamp:video:youtube:20200716:Microsoft AirSim: Applications to Research and Industry — PX4 Developer Summit Virtual 2020 -->

#### Autonomous Drone Inspections using AirSim and PX4 (PX4 Developer Summit Virtual 2020)

@[youtube](https://youtu.be/JDx0MPTlhrg) <!-- datestamp:video:youtube:20200716:Autonomous Drone Inspections using AirSim and PX4 — PX4 Developer Summit Virtual 2020 -->
@[youtube](https://youtu.be/JDx0MPTlhrg)

<!-- datestamp:video:youtube:20200716:Autonomous Drone Inspections using AirSim and PX4 — PX4 Developer Summit Virtual 2020 -->

## Further Information

Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
"linkcheck": "markdown_link_checker_sc -d en -i assets"
},
"dependencies": {
"vitepress": "^1.3.1",
"@red-asuka/vitepress-plugin-tabs": "^0.0.3",
"vue3-tabs-component": "^1.3.7",
"markdown-it-block-embed": "^0.0.3",
"markdown-it-mathjax3": "^4.3.2",
"markdown-it-video": "^0.6.3",
"medium-zoom": "^1.1.0"
"medium-zoom": "^1.1.0",
"vitepress": "^1.3.1",
"vue3-tabs-component": "^1.3.7"
}
}
Loading
Loading