Skip to content

Commit

Permalink
feat: 🎉 init vitepress
Browse files Browse the repository at this point in the history
  • Loading branch information
miggi92 authored Apr 24, 2024
1 parent ea7351f commit b7ad8eb
Show file tree
Hide file tree
Showing 5 changed files with 189 additions and 25 deletions.
28 changes: 28 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "ABAP OData Framework",
description: "A odata framework for a SAP System. ",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Examples', link: '/markdown-examples' }
],

sidebar: [
{
text: 'Examples',
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
]
}
],

socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
]
}
})
49 changes: 49 additions & 0 deletions docs/api-examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
outline: deep
---

# Runtime API Examples

This page demonstrates usage of some of the runtime APIs provided by VitePress.

The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:

```md
<script setup>
import { useData } from 'vitepress'

const { theme, page, frontmatter } = useData()
</script>

## Results

### Theme Data
<pre>{{ theme }}</pre>

### Page Data
<pre>{{ page }}</pre>

### Page Frontmatter
<pre>{{ frontmatter }}</pre>
```

<script setup>
import { useData } from 'vitepress'

const { site, theme, page, frontmatter } = useData()
</script>

## Results

### Theme Data
<pre>{{ theme }}</pre>

### Page Data
<pre>{{ page }}</pre>

### Page Frontmatter
<pre>{{ frontmatter }}</pre>

## More

Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).
45 changes: 22 additions & 23 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,25 @@
---
title: OData Framework
description: OData framework
date created: Wednesday, August 23rd 2023, 5:11:52 pm
date modified: Tuesday, September 5th 2023, 5:38:15 pm
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
name: "ABAP OData Framework"
text: "A odata framework for a SAP System. "
tagline: My great project tagline
actions:
- theme: brand
text: Markdown Examples
link: /markdown-examples
- theme: alt
text: API Examples
link: /api-examples

features:
- title: Feature A
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature B
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature C
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
---
# OData Framework

![[odata_fw_logo_transparent.png]]

## Documentation

[[documentation/index|documentation]]

## Changelog

[[changelog/index|Changelog]]

## Project

[GitHub Repository](https://github.com/miggi92/odata-fw)

## Used for Documentation

- [Home (obsidian-publisher.netlify.app)](https://obsidian-publisher.netlify.app/)
- [MkDocs](https://www.mkdocs.org/)
85 changes: 85 additions & 0 deletions docs/markdown-examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Markdown Extension Examples

This page demonstrates some of the built-in markdown extensions provided by VitePress.

## Syntax Highlighting

VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:

**Input**

````md
```js{4}
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}
```
````

**Output**

```js{4}
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}
```

## Custom Containers

**Input**

```md
::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::
```

**Output**

::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::

## More

Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
"scripts": {
"unit": "rm -rf output && abap_transpile abap_transpile.json && echo RUNNING && node output/index.mjs",
"test": "npm run unit",
"abaplint": "abaplint --format codeframe"
"abaplint": "abaplint --format codeframe",
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:preview": "vitepress preview docs"
},
"repository": "github:miggi92/odata-fw",
"keywords": [
Expand All @@ -29,4 +32,4 @@
"@abaplint/transpiler-cli": "^2.7.5",
"vitepress": "^1.1.3"
}
}
}

0 comments on commit b7ad8eb

Please sign in to comment.