Skip to content

Commit fb5cb95

Browse files
kartefactkartefact
committed
Initial commit - Added docs
1 parent b218972 commit fb5cb95

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+17817
-0
lines changed

‎.github/workflows/deploys.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy VitePress site to Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
- name: Setup Node
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: 20
29+
cache: npm
30+
- name: Setup Pages
31+
uses: actions/configure-pages@v4
32+
- name: Install dependencies
33+
run: npm ci
34+
- name: Build with VitePress
35+
run: npm run docs:build
36+
- name: Upload artifact
37+
uses: actions/upload-pages-artifact@v3
38+
with:
39+
path: .vitepress/dist
40+
41+
deploy:
42+
environment:
43+
name: github-pages
44+
url: ${{ steps.deployment.outputs.page_url }}
45+
needs: build
46+
runs-on: ubuntu-latest
47+
name: Deploy
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*node_modules

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# abap2xlsx-docs
2+
3+
The files of the abap2xlsx [documentation](https://kartefact.github.io/abap2xlsx-docs/). Feel free to contribute if you find any typos or have additional content to add.

‎docs/.vitepress/config.mjs‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
export default defineConfig({
4+
title: 'abap2xlsx Documentation',
5+
description: 'Comprehensive documentation for the abap2xlsx library',
6+
srcDir: './',
7+
themeConfig: {
8+
nav: [
9+
{ text: 'Home', link: '/' },
10+
{ text: 'Getting Started', link: '/getting-started/installation' },
11+
{ text: 'Guide', link: '/guide/basic-usage' },
12+
{ text: 'API Reference', link: '/api/zcl-excel' },
13+
{ text: 'FAQ', link: '/faq' },
14+
{ text: 'Contributing', link: '/contributing/development-setup' }
15+
],
16+
sidebar: {
17+
'/': [
18+
{
19+
text: 'Introduction',
20+
items: [
21+
{ text: 'FAQ', link: '/faq' }
22+
]
23+
}
24+
],
25+
'/getting-started/': [
26+
{
27+
text: 'Getting Started',
28+
items: [
29+
{ text: 'Installation', link: '/getting-started/installation' },
30+
{ text: 'Quick Start', link: '/getting-started/quick-start' },
31+
{ text: 'System Requirements', link: '/getting-started/system-requirements' },
32+
{ text: 'Getting Started for Beginners', link: '/getting-started/getting-started-for-beginners' }
33+
]
34+
}
35+
],
36+
'/guide/': [
37+
{
38+
text: 'User Guide',
39+
items: [
40+
{ text: 'Basic Usage', link: '/guide/basic-usage' },
41+
{ text: 'Reading Excel Files', link: '/guide/reading-excel' },
42+
{ text: 'Working with Worksheets', link: '/guide/worksheets' },
43+
{ text: 'Formatting', link: '/guide/formatting' },
44+
{ text: 'Formulas', link: '/guide/formulas' },
45+
{ text: 'Charts', link: '/guide/charts' },
46+
{ text: 'Images', link: '/guide/images' },
47+
{ text: 'Data Conversion', link: '/guide/data-conversion' },
48+
{ text: 'ALV Integration', link: '/guide/alv-integration' },
49+
{ text: 'Performance', link: '/guide/performance' }
50+
]
51+
}
52+
],
53+
'/advanced/': [
54+
{
55+
text: 'Advanced Topics',
56+
items: [
57+
{ text: 'Custom Styles', link: '/advanced/custom-styles' },
58+
{ text: 'Conditional Formatting', link: '/advanced/conditional-formatting' },
59+
{ text: 'Pivot Tables', link: '/advanced/pivot-tables' },
60+
{ text: 'Data Validation', link: '/advanced/data-validation' },
61+
{ text: 'Password Protection', link: '/advanced/password-protection' },
62+
{ text: 'Templates', link: '/advanced/templates' },
63+
{ text: 'Automation', link: '/advanced/automation' },
64+
{ text: 'Macros', link: '/advanced/macros' }
65+
]
66+
}
67+
],
68+
'/api/': [
69+
{
70+
text: 'API Reference',
71+
items: [
72+
{ text: 'ZCL Excel', link: '/api/zcl-excel' },
73+
{ text: 'ZCL Excel Worksheet', link: '/api/zcl-excel-worksheet' },
74+
{ text: 'ZCL Excel Writer', link: '/api/zcl-excel-writer' },
75+
{ text: 'ZCL Excel Reader', link: '/api/zcl-excel-reader' },
76+
{ text: 'ZCL Excel Style', link: '/api/zcl-excel-style' },
77+
{ text: 'Error Handling', link: '/api/error-handling' }
78+
]
79+
}
80+
],
81+
'/examples/': [
82+
{
83+
text: 'Examples',
84+
items: [
85+
{ text: 'Basic Report', link: '/examples/basic-report' },
86+
{ text: 'Financial Report', link: '/examples/financial-report' },
87+
{ text: 'Dashboard', link: '/examples/dashboard' },
88+
{ text: 'Batch Processing', link: '/examples/batch-processing' },
89+
{ text: 'Integration Patterns', link: '/examples/integration-patterns' }
90+
]
91+
}
92+
],
93+
'/migration/': [
94+
{
95+
text: 'Migration',
96+
items: [
97+
{ text: 'From SAPLink', link: '/migration/from-saplink' },
98+
{ text: 'Version History', link: '/migration/version-history' },
99+
{ text: 'Breaking Changes', link: '/migration/breaking-changes' }
100+
]
101+
}
102+
],
103+
'/troubleshooting/': [
104+
{
105+
text: 'Troubleshooting',
106+
items: [
107+
{ text: 'Common Issues', link: '/troubleshooting/common-issues' },
108+
{ text: 'Performance Issues', link: '/troubleshooting/performance-issues' },
109+
{ text: 'Debugging', link: '/troubleshooting/debugging' },
110+
{ text: 'SAP Notes', link: '/troubleshooting/sap-notes' }
111+
]
112+
}
113+
],
114+
'/contributing/': [
115+
{
116+
text: 'Contributing',
117+
items: [
118+
{ text: 'Development Setup', link: '/contributing/development-setup' },
119+
{ text: 'Testing', link: '/contributing/testing' },
120+
{ text: 'Documentation', link: '/contributing/documentation' },
121+
{ text: 'Coding Guidelines', link: '/contributing/coding-guidelines' },
122+
{ text: 'Publishing a New Release', link: '/contributing/publishing-a-new-release' }
123+
]
124+
}
125+
],
126+
'/legacy-docs/': [
127+
{
128+
text: 'Legacy Documentation',
129+
items: [
130+
{ text: 'ABAP2XLSX Calendar Gallery', link: '/legacy-docs/abap2xlsx-Calender-Gallery' },
131+
{ text: 'abapGit Installation', link: '/legacy-docs/abapGit-installation' },
132+
{ text: 'Getting ABAP2XLSX to Work on a 620 System', link: '/legacy-docs/Getting-ABAP2XLSX-to-work-on-a-620-System' },
133+
{ text: 'SAPLink Installation', link: '/legacy-docs/SAPLink-installation' }
134+
]
135+
}
136+
]
137+
},
138+
socialLinks: [
139+
{ icon: 'github', link: 'https://github.com/abap2xlsx/abap2xlsx' }
140+
],
141+
footer: {
142+
message: 'Released under the Apache 2.0 License.',
143+
copyright: 'Copyright © 2025 abap2xlsx contributors'
144+
}
145+
}
146+
})

0 commit comments

Comments
 (0)