Skip to content

Commit

Permalink
docs: reorg docs datastructure
Browse files Browse the repository at this point in the history
  • Loading branch information
phodal committed Jan 6, 2024
1 parent e8f9f7d commit 9dbf99f
Show file tree
Hide file tree
Showing 10 changed files with 470 additions and 87 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

> CHAPI (Common Hierarchical Abstract Parser and Information Converter) streamlines code analysis by converting diverse
> language source code into a unified abstract model, simplifying cross-language development. Chapi
> 是一个通用层次抽象解析器与信息转换器,它可以将不同编程语言的源代码转换为统一的层次抽象模型。一个通用语言元信息转换器,能将不同语言转换为相同的模型。
> 是一个通用层次抽象解析器与信息转换器,它可以将不同编程语言的源代码转换为统一的层次抽象模型。
Chapi => Cha Pi => Tea Pi => Tea π => 茶 π. See on in
refs: [Tea if by sea, cha if by land](https://qz.com/1176962/map-how-the-word-tea-spread-over-land-and-sea-to-conquer-the-world/).
Expand Down Expand Up @@ -103,8 +103,8 @@ Algol Family [https://wiki.c2.com/?AlgolFamily](https://wiki.c2.com/?AlgolFamily

```
dependencies {
implementation 'com.phodal.chapi:chapi-ast-java:0.2.0'
implementation 'com.phodal.chapi:chapi-domain:0.2.0'
implementation 'com.phodal.chapi:chapi-ast-java:2.2.2'
implementation 'com.phodal.chapi:chapi-domain:2.2.2'
}
```

Expand Down
1 change: 0 additions & 1 deletion _config.yml

This file was deleted.

13 changes: 0 additions & 13 deletions docs/README.md

This file was deleted.

95 changes: 95 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
remote_theme: pmarsceill/just-the-docs

title: Chapi
description: CHAPI (Common Hierarchical Abstract Parser and Information Converter) streamlines code analysis by converting diverse language source code into a unified abstract model, simplifying cross-language development.

heading_anchors: true

footer_content: "This code is distributed under the MPL 2.0 license. See `LICENSE` in this directory."

# Footer last edited timestamp
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html

# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub."
gh_edit_repository: "https://github.com/phodal/chapi" # the github URL for your repo
gh_edit_branch: "master" # the branch that your docs are served from
gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

callouts_level: quiet # or loud
callouts:
highlight:
color: yellow
important:
title: Important
color: blue
new:
title: New
color: green
note:
title: Note
color: purple
warning:
title: Warning
color: red

# Enable or disable the site search
# Supports true (default) or false
search_enabled: true

search:
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
heading_level: 4
# Maximum amount of previews per search result
# Default: 3
previews: 3
# Maximum amount of words to display before a matched word in the preview
# Default: 5
preview_words_before: 5
# Maximum amount of words to display after a matched word in the preview
# Default: 10
preview_words_after: 10
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
tokenizer_separator: /[\s/]+/
# Display the relative url in search results
# Supports true (default) or false
rel_url: true
# Enable or disable the search button that appears in the bottom right corner of every page
# Supports true or false (default)
button: false


# Back to top link
back_to_top: true
back_to_top_text: "Back to top"

# Google Analytics Tracking (optional)
# e.g, UA-1234567-89
# ga_tracking: G-JR0EZ3NLE1
# ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true by default)

url: "https://chapi.phodal.com" # the base hostname & protocol for your site

# Aux links for the upper right navigation
aux_links:
"View in on GitHub":
- "//github.com/phodal/chapi"

# Makes Aux links open in a new tab. Default is false
aux_links_new_tab: true

mermaid:
# Version of mermaid library
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
version: "10.4.0"


plugins:
- jekyll-seo-tag
- jekyll-sitemap
19 changes: 0 additions & 19 deletions docs/adr/0001-support-for-sql-.md

This file was deleted.

24 changes: 0 additions & 24 deletions docs/adr/0002-setup-powerful-build-system.md

This file was deleted.

21 changes: 0 additions & 21 deletions docs/adr/0003-add-publish-multiple-jar.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/adr/README.md

This file was deleted.

Loading

0 comments on commit 9dbf99f

Please sign in to comment.