Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert the doc format to Markdown #2759

Closed
wants to merge 1 commit into from

Conversation

awxiaoxian2020
Copy link
Contributor

closes #2691
closes #2564

it's in process.

@coveralls
Copy link

coveralls commented Dec 17, 2022

Coverage Status

Coverage: 87.396% (+0.08%) from 87.313% when pulling b837a5d on awxiaoxian2020:markdown into 35262b0 on mybatis:master.

@harawata
Copy link
Member

Hi @awxiaoxian2020 ,

Just to let you know that maven-site-plugin can handle multiple different formats (i.e. XDOC and Markdown) at the same time.
So, for example, if you are working on configuration first, it is OK to have a file structure as follows.

├── ja
│   ├── markdown
│   │   └── configuration.md
│   ├── resources
│   │   └── css
│   │       └── site.css
│   └── xdoc
│       ├── dynamic-sql.xml
│       ├── getting-started.xml
│       ├── index.xml
│       ├── java-api.xml
│       ├── logging.xml
│       ├── sqlmap-xml.xml
│       └── statement-builders.xml

If you want to convert all files in one PR, that is OK, but it'll take us longer to review and increase the chance of conflict with other contributors work.

@awxiaoxian2020
Copy link
Contributor Author

@harawata It seems that we lost the skin...

@harawata
Copy link
Member

harawata commented Jan 3, 2023

@awxiaoxian2020 ,
I don't know much about site generation.
You should take a look at the doc files in the mybatis-spring project.
They were converted to markdown a while ago.
https://github.com/mybatis/spring/tree/master/src/site

@awxiaoxian2020
Copy link
Contributor Author

@awxiaoxian2020 , I don't know much about site generation. You should take a look at the doc files in the mybatis-spring project. They were converted to markdown a while ago. https://github.com/mybatis/spring/tree/master/src/site

Thanks for your suggestions! I found I didn't download the mybatis-parent on my local machine when I build the site...the skin is defined in the parent site.xml.

@hazendaz
Copy link
Member

hazendaz commented Jan 4, 2023

@awxiaoxian2020 You may have to include that now with this effort. The other uses velocity and it inherits it from the parent automatically via maven.

@awxiaoxian2020
Copy link
Contributor Author

close for clean commit. this PR is superseded by #2784.

@awxiaoxian2020 awxiaoxian2020 deleted the markdown branch January 31, 2023 02:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Convert the doc format from XDOC to Markdown Use the placeholder in doc for artifact version
4 participants