Browse Source

fix: update markdown format

trgiangdo 1 year ago
parent
commit
356260bd3b

+ 0 - 1
.editorconfig

@@ -17,7 +17,6 @@ indent_size = 2
 charset = utf-8
 end_of_line = lf
 
-
 [*.bat]
 indent_style = tab
 end_of_line = crlf

+ 2 - 3
.github/ISSUE_TEMPLATE/bug_report.md

@@ -13,12 +13,12 @@ A complete and clear description of the problem.
 **How to reproduce**
 
 - A code fragment
-    ```
+    ```python
     from taipy import ...
     ```
 
 - And/or configuration files or code:
-    ```
+    ```python
     from taipy import Config;
 
 
@@ -44,4 +44,3 @@ and any other relevant information.
 **Acceptance Criteria**
 - [ ] Ensure new code is unit tested, and check code coverage is at least 90%
 - [ ] Create related issue in taipy-doc for documentation and Release Notes if relevant
-

+ 3 - 3
CONTRIBUTING.md

@@ -97,9 +97,9 @@ working on it.
    This tool will run before each commit and will automatically reformat code or raise warnings and errors based on the
    code format or Python typing.
    You can install and setup it up by doing:
-   ```
-     pipenv install pre-commit
-     pipenv run python -m pre-commit install
+   ```bash
+   $ pipenv install pre-commit
+   $ pipenv run python -m pre-commit install
    ```
 
 4. Make the changes.<br/>

+ 6 - 0
MANIFEST.in

@@ -1,20 +1,26 @@
 recursive-include tools *
+
 # Package taipy
 include taipy/*.json
 include taipy/gui_core/*.json
 include taipy/gui_core/lib/*.js
+
 # Package taipy-config
 include taipy/config/*.pyi
 include taipy/config/*.json
+
 # Package taipy-core
 include taipy/core/*.json
 include taipy/core/config/*.json
+
 # Package taipy-gui
 recursive-include taipy/gui/webapp *
 include taipy/gui/version.json
 include taipy/gui/viselements.json
 include taipy/gui/*.pyi
+
 # Package taipy-rest
 include taipy/rest/*.json
+
 # Package taipy-templates
 recursive-include taipy/templates *

+ 2 - 2
README.md

@@ -59,8 +59,8 @@ Taipy is designed for data scientists and machine learning engineers to build fu
 
 ## ⚙️ Quickstart
 To install Taipy stable release run:
-```
-pip install taipy
+```bash
+$ pip install taipy
 ```
 
 To install Taipy on a Conda Environment or from source, please refer to the [Installation Guide](https://docs.taipy.io/en/latest/installation/).<br />

+ 10 - 11
doc/gui/extension/README.md

@@ -148,14 +148,14 @@ the "TAIPY_DIR" variable is set, we can build the JavaScript module file:
 - Set your directory to `example_library/front-end`
 - Install the Taipy GUI JavaScript bundle and the other dependencies:<br/>
   You must run the command:
-  ```
-  npm install
+  ```bash
+  $ npm install
   ```
   This command will fail with a message indicating that the Taipy GUI 'webapp' directory
   could not be found if the "TAIPY_DIR" environment variable was not set properly.
 - You can now build the custom element library JavaScript bundle file:
-  ```
-  npm run build
+  ```bash
+  $ npm run build
   ```
   This generates the bundle `exampleLibrary.js` in the `dist` directory (if you have not
   changed the `output` settings in `webpack.config.js`). This file contains the definition
@@ -168,8 +168,8 @@ creates a Taipy GUI application with a page that demonstrates the various
 elements defined by this extension library example.
 
 To execute this application, you can run:
-```sh
-python main.py
+```bash
+$ python main.py
 ```
 (prefixed by `pipenv run` if you are using `pipenv`)
 
@@ -180,16 +180,15 @@ You can create an autonomous Python package for this extension library.
 The following two simple steps must be performed:
 
 - Install the build package:
-  ```sh
-  pip install build
+  ```bash
+  $ pip install build
   ```
   (prefixed by `pipenv run` if you are using `pipenv`)
 - Build the package:
-  ```sh
-  python -m build
+  ```bash
+  $ python -m build
   ```
   (prefixed by `pipenv run` if you are using `pipenv`)
 
 This generates an autonomous Python package that contains both the back-end and the
 front-end code for the extension library.
-

+ 1 - 1
frontend/taipy-gui/README.md

@@ -15,7 +15,7 @@ of the standard installation.
 To build the Taipy GUI bundle, you must set your current directory to this directory and then
 run the following commands:
 
-```console
+```bash
 # Current directory is the directory where this README file is located:
 #   [taipy-dir]/frontend/taipy-gui
 #

+ 4 - 5
frontend/taipy-gui/extension-index.md

@@ -26,15 +26,15 @@ The Extension API is located by the 'taipy-gui' module.
 
 In order to import items from this module, you have to install it, using `npm`.
 The most simple way to install the Taipy GUI Extension module is:
-```
-npm i <TAIPY_DIR>/taipy/gui/webapp
+```bash
+$ npm i <TAIPY_DIR>/taipy/gui/webapp
 ```
 
 Where *<TAIPY_DIR>* represents the directory where, in the development machine's
 filesystem, the Taipy GUI Python package has been installed.
 
 When the package is installed, your JavaScript code can import items from it:
-```
+```javascript
 import { ... } from "taipy-gui";
 ```
 
@@ -61,11 +61,10 @@ In order for the front-end to notify the backend of a change or query data, an `
 must be created (using the `create*Action()` functions) and dispatched to the React
 context:
 
-```
+```javascript
 const dispatch = useDispatch();
 ...
 const action = create*Action(...);
 ...
 dispatch(action);
 ```
-

+ 1 - 1
frontend/taipy/README.md

@@ -13,7 +13,7 @@ Check [this file](../taipy-gui/README.md) for more information.
 To build the Taipy bundle, you must set your current directory to this directory and then
 run the following commands:
 
-```console
+```bash
 # Current directory is the directory where this README file is located:
 #   [taipy-dir]/frontend/taipy
 #

+ 3 - 3
taipy/config/CONTRIBUTING.md

@@ -97,9 +97,9 @@ working on it.
    This tool will run before each commit and will automatically reformat code or raise warnings and errors based on the
    code format or Python typing.
    You can install and setup it up by doing:
-   ```
-     pipenv install pre-commit
-     pipenv run python -m pre-commit install
+   ```bash
+   $ pipenv install pre-commit
+   $ pipenv run python -m pre-commit install
    ```
 
 4. Make the changes.<br/>

+ 3 - 3
taipy/core/CONTRIBUTING.md

@@ -97,9 +97,9 @@ working on it.
    This tool will run before each commit and will automatically reformat code or raise warnings and errors based on the
    code format or Python typing.
    You can install and setup it up by doing:
-   ```
-     pipenv install pre-commit
-     pipenv run python -m pre-commit install
+   ```bash
+   $ pipenv install pre-commit
+   $ pipenv run python -m pre-commit install
    ```
 
 4. Make the changes.<br/>

+ 3 - 3
taipy/gui/CONTRIBUTING.md

@@ -97,9 +97,9 @@ working on it.
    This tool will run before each commit and will automatically reformat code or raise warnings and errors based on the
    code format or Python typing.
    You can install and setup it up by doing:
-   ```
-     pipenv install pre-commit
-     pipenv run python -m pre-commit install
+   ```bash
+   $ pipenv install pre-commit
+   $ pipenv run python -m pre-commit install
    ```
 
 4. Make the changes.<br/>

+ 9 - 9
taipy/gui/INSTALLATION.md

@@ -22,7 +22,7 @@ The easiest way to install Taipy GUI is using pip
 
 Run the command:
 ```bash
-pip install taipy-gui
+$ pip install taipy-gui
 ```
 
 ## Installing the development version
@@ -36,7 +36,7 @@ You should also install this version if you want to contribute to the developmen
 
 Clone the Taipy repository using the following command:
 ```bash
-git clone https://github.com/Avaiga/taipy.git
+$ git clone https://github.com/Avaiga/taipy.git
 ```
 
 This creates the 'taipy' directory holding all the package's source code, and the 'taipy-gui'
@@ -62,18 +62,18 @@ Open a new terminal and run the following commands:
 
 - Install the DOM dependencies
 ```bash
-cd gui
-cd dom
-npm i
+$ cd gui
+$ cd dom
+$ npm i
 ```
 - Install the web app dependencies
 ```bash
-cd ..
-npm i --omit=optional
+$ cd ..
+$ npm i --omit=optional
 ```
 - Build the web app
 ```bash
-npm run build
+$ npm run build
 ```
 
 After a few minutes, this creates the directory `taipy/gui/webapp` in the root directory of the repository
@@ -83,7 +83,7 @@ where the front-end code for Taipy GUI is split into a set of JavaScript bundles
 
 In a terminal, **at the root of the repository**, run:
 ```bash
-pip install -e . --user
+$ pip install -e . --user
 ```
 
 This should install the dev version of Taipy GUI as editable. You are now ready to use it.

+ 3 - 3
taipy/rest/CONTRIBUTING.md

@@ -97,9 +97,9 @@ working on it.
    This tool will run before each commit and will automatically reformat code or raise warnings and errors based on the
    code format or Python typing.
    You can install and setup it up by doing:
-   ```
-     pipenv install pre-commit
-     pipenv run python -m pre-commit install
+   ```bash
+   $ pipenv install pre-commit
+   $ pipenv run python -m pre-commit install
    ```
 
 4. Make the changes.<br/>

+ 3 - 3
taipy/templates/CONTRIBUTING.md

@@ -97,9 +97,9 @@ working on it.
    This tool will run before each commit and will automatically reformat code or raise warnings and errors based on the
    code format or Python typing.
    You can install and setup it up by doing:
-   ```
-     pipenv install pre-commit
-     pipenv run python -m pre-commit install
+   ```bash
+   $ pipenv install pre-commit
+   $ pipenv run python -m pre-commit install
    ```
 
 4. Make the changes.<br/>