Skip to content

Commit e9f9588

Browse files
Progi1984Progi1984
authored
Merge pull request #7 from PHPOffice/doc
Added documentation (MkDocs / Coverage / PHPDoc)
2 parents e5cf3e9 + 28810f8 commit e9f9588

File tree

20 files changed

+758
-2
lines changed

20 files changed

+758
-2
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v2
15+
### MkDocs
16+
- name: Setup Python
17+
uses: actions/setup-python@v2
18+
with:
19+
python-version: 3.x
20+
- name: Install Python Dependencies
21+
run: pip install mkdocs-material autolink-references-mkdocs-plugin
22+
- name: Build documentation
23+
run: mkdocs build --site-dir public
24+
### PHPUnit
25+
- name: Setup PHP
26+
uses: shivammathur/setup-php@v2
27+
with:
28+
php-version: 7.1
29+
extensions: dom, xml
30+
coverage: xdebug
31+
- name: Create directory public/coverage
32+
run: mkdir ./public/coverage
33+
- name: Install PHP Dependencies
34+
run: composer install --ansi --prefer-dist --no-interaction --no-progress
35+
- name: Build Coverage Report
36+
run: XDEBUG_MODE=coverage ./vendor/bin/phpunit -c ./ --coverage-text --coverage-html ./public/coverage
37+
### PHPDoc
38+
#- name: Create directory public/docs
39+
# run: mkdir ./public/docs
40+
#- name: Install PhpDocumentor
41+
# run: wget https://phpdoc.org/phpDocumentor.phar && chmod +x phpDocumentor.phar
42+
#- name: Build Documentation
43+
# run: ./phpDocumentor.phar run -d ./src -t ./public/docs
44+
45+
### Deploy
46+
- name: Deploy
47+
uses: peaceiris/actions-gh-pages@v3
48+
if: github.ref == 'refs/heads/master'
49+
with:
50+
github_token: ${{ secrets.GITHUB_TOKEN }}
51+
publish_dir: ./public

‎.github/workflows/php.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: PHPOffice/Math
1+
name: PHP
22
on:
33
push:
44
branches:

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
.phpunit.cache
33
.phpunit.result.cache
44
composer.lock
5+
phpDocumentor.phar
56

6-
vendor/
7+
public/
8+
vendor/

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 PhpSpreadsheet Authors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎composer.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
],
1919
"require": {
2020
"php": "^7.1|^8.0",
21+
"ext-dom": "*",
2122
"ext-xml": "*"
2223
},
2324
"require-dev": {

‎docs/assets/mathjax.js‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
window.MathJax = {
2+
tex: {
3+
inlineMath: [["\\(", "\\)"]],
4+
displayMath: [["\\[", "\\]"]],
5+
processEscapes: true,
6+
processEnvironments: true
7+
},
8+
options: {
9+
ignoreHtmlClass: ".*|",
10+
processHtmlClass: "arithmatex"
11+
}
12+
};
13+
14+
document$.subscribe(() => {
15+
MathJax.typesetPromise()
16+
})
17+

‎docs/changes/0.1.0.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# 0.1.0
2+
3+
## Enhancements
4+
5+
- Initial version by [@Progi1984](https://github/Progi1984)
6+
- MathML Reader : Support for Semantics by [@Progi1984](https://github/Progi1984) in [#4](https://github.com/PHPOffice/Math/pull/4)
7+
8+
## Bug fixes
9+
10+
- N/A
11+
12+
## Miscellaneous
13+
- Github Actions : PHPCSFixer by [@Progi1984](https://github/Progi1984) in [#1](https://github.com/PHPOffice/Math/pull/1)
14+
- Github Actions : PHPStan by [@Progi1984](https://github/Progi1984) in [#2](https://github.com/PHPOffice/Math/pull/2)
15+
- Removed dependency friendsofphp/php-cs-fixer by [@Progi1984](https://github/Progi1984) in [#3](https://github.com/PHPOffice/Math/pull/3)
16+
- Github Actions : Dependabot by [@Progi1984](https://github/Progi1984) in [#5](https://github.com/PHPOffice/Math/pull/5)
17+
- Bump actions/checkout from 2 to 4 by [@dependabot](https://github/dependabot) in [#6](https://github.com/PHPOffice/Math/pull/6)
18+
- Added documentation (MkDocs / Coverage / PHPDoc) by [@Progi1984](https://github/Progi1984) in [#7](https://github.com/PHPOffice/Math/pull/7)

‎docs/credits.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## References
2+
3+
### MathML
4+
5+
- [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/MathML)
6+
7+
### OfficeMathML
8+

‎docs/index.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
#
2+
3+
Math is a library written in pure PHP that provides a set of classes to manipulate different formula file formats, i.e. [MathML](https://en.wikipedia.org/wiki/MathML) and [Office MathML (OOML)](https://en.wikipedia.org/wiki/Office_Open_XML_file_formats#Office_MathML_(OMML)).
4+
5+
Math is an open source project licensed under the terms of [MIT](https://github.com/PHPOffice/PHPWord/blob/master/LICENCE). Math is aimed to be a high quality software product by incorporating [continuous integration and unit testing](https://github.com/PHPOffice/Math/actions/workflows/php.yml). You can learn more about Math by reading this Developers'Documentation and the [API Documentation](http://phpoffice.github.io/PHPWord/docs/develop/)
6+
7+
## Features
8+
9+
- Insert elements:
10+
11+
* Basic :
12+
13+
* Identifier : <math display="inline"><mi>a</mi></math>
14+
* Operator : <math display="inline"><mo>+</mo></math>
15+
* Numeric : <math display="inline"><mn>2</mn></math>
16+
17+
* Simple :
18+
19+
* Fraction : <math display="inline"><mfrac><mi>a</mi><mn>3</mn></mfrac></math>
20+
* Superscript : <math display="inline"><msup><mi>a</mi><mn>3</mn></msup></math>
21+
22+
* Architectural :
23+
24+
* Row
25+
* Semantics
26+
27+
## Support
28+
29+
### Readers
30+
31+
| Features | | MathML | Office MathML |
32+
|---------------------------|----------------------|:----------------:|:----------------:|
33+
| **Basic** | Identifier | :material-check: | :material-check: |
34+
| | Operator | :material-check: | :material-check: |
35+
| | Numeric | :material-check: | :material-check: |
36+
| **Simple** | Fraction | :material-check: | :material-check: |
37+
| | Superscript | :material-check: | |
38+
| **Architectural** | Row | :material-check: | |
39+
| | Semantics | :material-check: | |
40+
41+
### Writers
42+
43+
| Features | | MathML | Office MathML |
44+
|---------------------------|----------------------|:----------------:|:----------------:|
45+
| **Basic** | Identifier | :material-check: | :material-check: |
46+
| | Operator | :material-check: | :material-check: |
47+
| | Numeric | :material-check: | :material-check: |
48+
| **Simple** | Fraction | :material-check: | :material-check: |
49+
| | Superscript | :material-check: | |
50+
| **Architectural** | Row | :material-check: | :material-check: |
51+
| | Semantics | | |
52+
53+
## Contributing
54+
55+
We welcome everyone to contribute to Math. Below are some of the things that you can do to contribute:
56+
57+
- [Fork us](https://github.com/PHPOffice/Math/fork) and [request a pull](https://github.com/PHPOffice/Math/pulls) to the [master](https://github.com/PHPOffice/Math/tree/master) branch
58+
- Submit [bug reports or feature requests](https://github.com/PHPOffice/Math/issues) to GitHub
59+
- Follow [@PHPOffice](https://twitter.com/PHPOffice) on Twitter

‎docs/install.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Installation
2+
3+
## Requirements
4+
5+
Mandatory:
6+
7+
- PHP 7.1+
8+
- PHP [DOM extension](http://php.net/manual/en/book.dom.php)
9+
- PHP [XML Parser extension](http://www.php.net/manual/en/xml.installation.php)
10+
- PHP [XMLWriter extension](http://php.net/manual/en/book.xmlwriter.php)
11+
12+
13+
## Installation
14+
15+
### Using Composer
16+
17+
To install via [Composer](http://getcomposer.org), add the following lines to your `composer.json`:
18+
19+
``` json
20+
{
21+
"require": {
22+
"phpoffice/math": "dev-master"
23+
}
24+
}
25+
```

0 commit comments

Comments
 (0)