Skip to content

Commit

Permalink
Merge pull request ResetPower#1 from ResetPower/dev
Browse files Browse the repository at this point in the history
Add Introduction in the Documents
  • Loading branch information
ResetPower authored Jul 21, 2024
2 parents dc287c8 + 131dea7 commit 27d1297
Show file tree
Hide file tree
Showing 9 changed files with 58 additions and 162 deletions.
10 changes: 10 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
module.exports = {
tabWidth: 2,
useTabs: false,
quoteProps: "as-needed",
semi: true,
singleQuote: false,
bracketSpacing: true,
endOfLine: "auto",
trailingComma: "es5",
};
28 changes: 13 additions & 15 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,28 +1,26 @@
import { defineConfig } from 'vitepress'
import { defineConfig } from "vitepress";

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "OpenCAS",
description: "A VitePress Site",
description: "An Open-Source Computer Algebra System",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Examples', link: '/markdown-examples' }
{ text: "Home", link: "/" },
{ text: "Documents", link: "/what-is-opencas" },
],

sidebar: [
{
text: 'Examples',
text: "Introduction",
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
]
}
{ text: "What is OpenCAS?", link: "/what-is-opencas" },
{ text: "Quickstart", link: "/quickstart" },
],
},
],

socialLinks: [
{ icon: 'github', link: 'https://github.com/ResetPower/OpenCAS' }
]
}
})
{ icon: "github", link: "https://github.com/ResetPower/OpenCAS" },
],
},
});
49 changes: 0 additions & 49 deletions docs/api-examples.md

This file was deleted.

25 changes: 12 additions & 13 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,21 @@ layout: home

hero:
name: "OpenCAS"
text: "A VitePress Site"
tagline: My great project tagline
text: "Facilitates Calculation"
tagline: An Open-Source Computer Algebra System
actions:
- theme: brand
text: Markdown Examples
link: /markdown-examples
text: What is OpenCAS?
link: /what-is-opencas
- theme: alt
text: API Examples
link: /api-examples
text: Quickstart
link: /quickstart

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
- title: Feature Alpha
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
- title: Feature Beta
details: Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
- title: Feature Gamma
details: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
---

85 changes: 0 additions & 85 deletions docs/markdown-examples.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Quickstart

This project currently remains in conception and is not carried out on code. You can contact to us if you are interested in this project. The guidelines for contribution will be available on this website later.
3 changes: 3 additions & 0 deletions docs/what-is-opencas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# What is OpenCAS?

OpenCAS is an open-source computer algebra system (CAS) designed for symbolic operations in mathematics. The project is started in Jul 2024 and is planned for an extended duration of development.
16 changes: 16 additions & 0 deletions package-lock.json

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

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"docs:preview": "vitepress preview docs"
},
"devDependencies": {
"prettier": "^3.3.3",
"vitepress": "^1.3.1"
}
}

0 comments on commit 27d1297

Please sign in to comment.