Skip to content

Commit 4d2e4c1

Browse files
committed
update
1 parent e78f69a commit 4d2e4c1

5 files changed

Lines changed: 27 additions & 302 deletions

File tree

.idea/inspectionProfiles/Project_Default.xml

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/.vuepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export default defineUserConfig({
88
locales: {
99
"/": {
1010
lang: "en-US",
11-
title: "Docs Demo",
11+
title: "Headwind Simulations Documentation",
1212
description: "A docs demo for vuepress-theme-hope",
1313
}
1414
},

src/.vuepress/styles/config.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
// you can change config here
2-
$theme-color: #096dd9;
2+
$theme-color: #ea580c;

src/.vuepress/theme.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ import { enNavbar, zhNavbar } from "./navbar/index.js";
44
import { enSidebar, zhSidebar } from "./sidebar/index.js";
55

66
export default hopeTheme({
7+
darkmode: "enable",
78
hostname: "https://vuepress-theme-hope-docs-demo.netlify.app",
89

910
author: {
1011
name: "Mr.Hope",
1112
url: "https://mister-hope.com",
1213
},
1314

14-
logo: "https://theme-hope-assets.vuejs.press/logo.svg",
15+
logo: "https://raw.githubusercontent.com/headwindsim/branding/refs/heads/main/logos/Headwind.svg",
1516

1617
repo: "headwindsim/docs",
1718

src/README.md

Lines changed: 18 additions & 299 deletions
Original file line numberDiff line numberDiff line change
@@ -1,321 +1,40 @@
11
---
2+
containerClass: home
23
home: true
34
icon: house
4-
title: Project home
5-
heroImage: https://theme-hope-assets.vuejs.press/logo.svg
6-
bgImage: https://theme-hope-assets.vuejs.press/bg/6-light.svg
7-
bgImageDark: https://theme-hope-assets.vuejs.press/bg/6-dark.svg
8-
bgImageStyle:
9-
background-attachment: fixed
10-
heroText: Project name
11-
tagline: You can place the description of the project here.
5+
title: Home
6+
heroImage: https://raw.githubusercontent.com/headwindsim/branding/refs/heads/main/logos/Headwind.svg
7+
heroText: Headwind Documentation
8+
tagline: Welcome to the documentation and guides hub for Headwind Simulations' open-source, community-driven projects. <br><br> Here, you'll find a wide range of resources to help you navigate and utilize our aircraft simulations. You'll also discover how you can contribute to the development and improvement of ongoing Headwind Simulations projects!
129
actions:
13-
- text: How to Use
14-
icon: lightbulb
10+
- text: Get Started
1511
link: ./demo/
1612
type: primary
1713

1814
- text: Docs
1915
link: ./guide/
2016

2117
highlights:
22-
- header: Easy to install
23-
image: /assets/image/box.svg
24-
bgImage: https://theme-hope-assets.vuejs.press/bg/3-light.svg
25-
bgImageDark: https://theme-hope-assets.vuejs.press/bg/3-dark.svg
26-
highlights:
27-
- title: Run <code>pnpm create vuepress-theme-hope hope-project</code> to create a new project with this theme.
28-
- title: Run <code>pnpm create vuepress-theme-hope add .</code> in your project root to create a new project with this theme.
29-
30-
- header: Add things you want in markdown
31-
description: We extended the standard commonMark specification and added tons of new features for you.
32-
image: /assets/image/markdown.svg
33-
bgImage: https://theme-hope-assets.vuejs.press/bg/2-light.svg
34-
bgImageDark: https://theme-hope-assets.vuejs.press/bg/2-dark.svg
35-
bgImageStyle:
36-
background-repeat: repeat
37-
background-size: initial
38-
features:
39-
- title: Links Check
40-
icon: clipboard-check
41-
details: Check markdown links
42-
link: https://theme-hope.vuejs.press/guide/markdown/others.html#link-check
43-
44-
- title: Hint box
45-
icon: box-archive
46-
details: Decorate Markdown content with styles
47-
link: https://theme-hope.vuejs.press/guide/markdown/stylize/hint.html
48-
49-
- title: GFM alerts
50-
icon: bell
51-
details: GFM alert box
52-
link: https://theme-hope.vuejs.press/guide/markdown/stylize/alert.html
53-
54-
- title: Tabs
55-
icon: table-columns
56-
details: Group similar content with tabs and switch them together
57-
link: https://theme-hope.vuejs.press/guide/markdown/content/tabs.html
58-
59-
- title: Code Tabs
60-
icon: code
61-
details: Group similar codes with tabs
62-
link: https://theme-hope.vuejs.press/guide/markdown/code/code-tabs.html
63-
64-
- title: Custom Align
65-
icon: align-center
66-
details: Let you decide to align paragraphs in the way you like
67-
link: https://theme-hope.vuejs.press/guide/markdown/stylize/align.html
68-
69-
- title: Attrs
70-
icon: code
71-
details: Allow you to add attributes for Markdown content
72-
link: https://theme-hope.vuejs.press/guide/markdown/stylize/attrs.html
73-
74-
- title: Superscript and subscript
75-
icon: superscript
76-
details: Inserting superscript and subscript
77-
link: https://theme-hope.vuejs.press/guide/markdown/stylize/sup-sub.html
78-
79-
- title: Footnote
80-
icon: quote-left
81-
details: Your Markdown now support footnotes
82-
link: https://theme-hope.vuejs.press/guide/markdown/content/footnote.html
83-
84-
- title: Mark
85-
icon: highlighter
86-
details: Mark and highlight contents
87-
link: https://theme-hope.vuejs.press/guide/markdown/stylize/mark.html
88-
89-
- title: Spoiler
90-
icon: eraser
91-
details: Mark spoiler contents
92-
link: https://theme-hope.vuejs.press/guide/markdown/stylize/spoiler.html
93-
94-
- title: Tasklist
95-
icon: square-check
96-
details: Use tasklist in Markdown
97-
link: https://theme-hope.vuejs.press/guide/markdown/grammar/tasklist.html
98-
99-
- title: Image syntax
100-
icon: image
101-
details: improve syntax to specify size and color scheme
102-
link: https://theme-hope.vuejs.press/guide/markdown/grammar/image.html
103-
104-
- title: Component Support
105-
icon: puzzle-piece
106-
details: Easily insert components in Markdown
107-
link: https://theme-hope.vuejs.press/guide/component/grammar.html
108-
109-
- title: Components
110-
icon: puzzle-piece
111-
details: Common components out fo box
112-
link: https://theme-hope.vuejs.press/guide/component/built-in.html
113-
114-
- title: Chart Support
115-
icon: chart-simple
116-
details: Display charts in Markdown
117-
link: https://theme-hope.vuejs.press/guide/markdown/chart/chartjs.html
118-
119-
- title: Flowchart Support
120-
icon: route
121-
details: Create your flowchart in Markdown
122-
link: https://theme-hope.vuejs.press/guide/markdown/chart/flowchart.html
123-
124-
- title: Mermaid Support
125-
icon: chart-pie
126-
details: Add mermaid diagram in Markdown
127-
link: https://theme-hope.vuejs.press/guide/markdown/chart/mermaid.html
128-
129-
- title: Plantuml Support
130-
icon: diagram-project
131-
details: Add plantuml in Markdown
132-
link: https://theme-hope.vuejs.press/guide/markdown/chart/plantuml.html
133-
134-
- title: Tex Support
135-
icon: square-root-variable
136-
details: Markdown now have Tex Support so you can write your formula
137-
link: https://theme-hope.vuejs.press/guide/markdown/grammar/math.html
138-
139-
- title: Include snippet Support
140-
icon: fa6-brands:markdown
141-
details: split your docs with different parts and import them in Markdown
142-
link: https://theme-hope.vuejs.press/guide/markdown/content/include.html
143-
144-
- title: Playground Support
145-
icon: code
146-
details: You can add playground in Markdown files
147-
link: https://theme-hope.vuejs.press/guide/markdown/code/playground.html
148-
149-
- title: Kotlin playground Support
150-
icon: fa6-brands:kickstarter
151-
details: Reactive kotlin playground
152-
link: https://theme-hope.vuejs.press/guide/markdown/code/kotlin-playground.html
153-
154-
- title: Vue playground Support
155-
icon: fa6-brands:vuejs
156-
details: Show living vue component in playground
157-
link: https://theme-hope.vuejs.press/guide/markdown/code/vue-playground.html
158-
159-
- title: Sandpack playground Support
160-
icon: code
161-
details: A live coding environment driven by Sandpack.
162-
link: https://theme-hope.vuejs.press/guide/markdown/code/sandpack.html
163-
164-
- title: Code Demo Support
165-
icon: laptop-code
166-
details: You can insert code demo easily
167-
link: https://theme-hope.vuejs.press/guide/markdown/code/demo.html
168-
169-
- title: Presentation Support
170-
icon: person-chalkboard
171-
details: Insert presentation in Markdown files via Reveal.js
172-
link: https://theme-hope.vuejs.press/guide/markdown/content/revealjs.html
173-
174-
- header: Customizable UI
175-
description: Customizable outlook with full a11y support.
176-
image: /assets/image/ui.svg
177-
bgImage: https://theme-hope-assets.vuejs.press/bg/9-light.svg
178-
bgImageDark: https://theme-hope-assets.vuejs.press/bg/9-dark.svg
179-
highlights:
180-
- title: Dark Mode
181-
icon: circle-half-stroke
182-
details: Switch between light and dark modes freely
183-
link: https://theme-hope.vuejs.press/guide/interface/darkmode.html
184-
185-
- title: Customizable Theme Color
186-
icon: palette
187-
details: Set theme color with the brand color and even a picker
188-
link: https://theme-hope.vuejs.press/guide/interface/theme-color.html
189-
190-
- title: More
191-
icon: ellipsis
192-
details: RTL layout, print support, fullscreen button, etc.
193-
link: https://theme-hope.vuejs.press/guide/interface/others.html
194-
195-
- header: Improved layouts
196-
description: An awesome responsive layout
197-
image: /assets/image/layout.svg
198-
bgImage: https://theme-hope-assets.vuejs.press/bg/5-light.svg
199-
bgImageDark: https://theme-hope-assets.vuejs.press/bg/5-dark.svg
200-
highlights:
201-
- title: Navbar
202-
icon: window-maximize
203-
details: Fully customizable navbar with improved mobile support
204-
link: https://theme-hope.vuejs.press/guide/layout/navbar.html
205-
206-
- title: Sidebar
207-
icon: fas fa-window-maximize fa-rotate-270
208-
details: Generate sidebar based on page headings and file structure
209-
link: https://theme-hope.vuejs.press/guide/layout/sidebar.html
210-
211-
- title: Slide Page
212-
icon: person-chalkboard
213-
details: Adding slide pages to display things you like
214-
link: https://theme-hope.vuejs.press/guide/layout/slides.html
215-
216-
- title: Other Layout Improvement
217-
icon: object-group
218-
details: Improved page nav and new breadcrumb, footer and toc. We also bring you a brand new homepage.
219-
link: https://theme-hope.vuejs.press/guide/layout/
220-
221-
- header: New features
222-
image: /assets/image/features.svg
223-
bgImage: https://theme-hope-assets.vuejs.press/bg/1-light.svg
224-
bgImageDark: https://theme-hope-assets.vuejs.press/bg/1-dark.svg
225-
features:
226-
- title: Catalog Page
227-
icon: network-wired
228-
details: Auto generating catalog page and out of box catalog component
18+
- features:
19+
- title: Support Guide
20+
icon: comment-dots
21+
details: The essentials for troubleshooting, reporting issues on our GitHub, and providing the necessary information to our support teams.
22922
link: https://theme-hope.vuejs.press/guide/feature/catalog.html
23023

231-
- title: Pageviews and Comments
24+
- title: Reported Issues
23225
icon: comment-dots
233-
details: Pageview statistics and comment support with 4 comment service
26+
details: Encountering issues flying a FlyByWire aircraft? This section lists our most commonly reported issues, workarounds, and status of any fixes available.
23427
link: https://theme-hope.vuejs.press/guide/feature/comment.html
23528

236-
- title: Article Information
29+
- title: Beginner Guide
23730
icon: circle-info
238-
details: Add author, writing date, reading time, word count and other information to your article
239-
link: https://theme-hope.vuejs.press/guide/feature/page-info.html
31+
details: Our beginner guides are comprehensive gate-to-gate flight tutorial for our aircraft.
24032

241-
- title: Article Encryption
242-
icon: lock
243-
details: Encrypt you articles based on page links, so that only the one you want could see them
33+
- title: Contributing
34+
icon: users
35+
details: We are an open source development group and welcome contributors to the project! You'll find the resources you need in this section to help get you started with your first pull request.
24436
link: https://theme-hope.vuejs.press/guide/feature/encrypt.html
24537

246-
- title: Search
247-
icon: search
248-
details: Support docsearch and client search
249-
link: https://theme-hope.vuejs.press/guide/feature/search.html
250-
251-
- title: Code Block
252-
icon: code
253-
details: Customize code block themes, line number, highlight lines, copy button, etc.
254-
link: https://theme-hope.vuejs.press/guide/markdown/code/fence.html.html
255-
256-
- title: Image Preview
257-
icon: image
258-
details: Support viewing, zooming, sharing your page images like a gallery
259-
link: https://theme-hope.vuejs.press/guide/feature/photo-swipe.html
260-
261-
- header: Blogging
262-
description: Create personal blog with theme
263-
image: /assets/image/blog.svg
264-
bgImage: https://theme-hope-assets.vuejs.press/bg/5-light.svg
265-
bgImageDark: https://theme-hope-assets.vuejs.press/bg/5-dark.svg
266-
highlights:
267-
- title: Blog features
268-
icon: blog
269-
details: Listing your articles with their dates, tags and categories
270-
link: https://theme-hope.vuejs.press/guide/blog/intro.html
271-
272-
- title: Blog homepage
273-
icon: blog
274-
details: New blog homepage
275-
link: https://theme-hope.vuejs.press/guide/blog/home.html
276-
277-
- title: Blogger info
278-
icon: circle-info
279-
details: Customize avatar, name, slogan, introduction and social links
280-
link: https://theme-hope.vuejs.press/guide/blog/blogger.html
281-
282-
- title: Timeline
283-
icon: clock
284-
details: Read through blog posts in a timeline
285-
link: https://theme-hope.vuejs.press/guide/blog/timeline.html
286-
287-
- header: Advanced
288-
description: Advanced features to improve site SEO and user experience
289-
image: /assets/image/advanced.svg
290-
bgImage: https://theme-hope-assets.vuejs.press/bg/4-light.svg
291-
bgImageDark: https://theme-hope-assets.vuejs.press/bg/4-dark.svg
292-
highlights:
293-
- title: SEO Enhancement
294-
icon: dumbbell
295-
details: Optimize pages for search engines
296-
link: https://theme-hope.vuejs.press/guide/advanced/seo.html
297-
298-
- title: Sitemap
299-
icon: sitemap
300-
details: Generate a Sitemap for your site
301-
link: https://theme-hope.vuejs.press/guide/advanced/sitemap.html
302-
303-
- title: Feed
304-
icon: rss
305-
details: Generate feed to allow users to subscribe it
306-
link: https://theme-hope.vuejs.press/guide/advanced/feed.html
307-
308-
- title: PWA
309-
icon: mobile-screen
310-
details: Make your site more like an APP
311-
link: https://theme-hope.vuejs.press/guide/advanced/pwa.html
312-
31338
copyright: false
31439
footer: Theme by <a href="https://theme-hope.vuejs.press/" target="_blank">VuePress Theme Hope</a> | MIT Licensed, Copyright © 2019-present Mr.Hope
315-
---
316-
317-
This is an example of a project homepage. You can place your main content here.
318-
319-
To use this layout, you need to set `home: true` in the page front matter.
320-
321-
For related descriptions of configuration items, please see [Project HomePage Layout Config](https://theme-hope.vuejs.press/guide/layout/home/).
40+
---

0 commit comments

Comments
 (0)