https://github.com/codeigniter4/docs-update
https://github.com/codeigniter4/docs-update
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codeigniter4/docs-update
- Owner: codeigniter4
- License: other
- Created: 2023-12-19T14:32:36.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2023-12-24T08:03:25.000Z (over 1 year ago)
- Last Synced: 2025-03-20T08:24:24.396Z (3 months ago)
- Language: PHP
- Size: 2.24 MB
- Stars: 2
- Watchers: 8
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CodeIgniter Documentation Project
The aim of this project is to convert the CodeIgniter User Guide from the existing reStructuredText format to Markdown format,
making it easier to maintain and contribute to, as well as allowing all of our projects to share a common documentation format.
## The Conversion Process
The conversion process is being done using pandoc to do the initial conversion.
From there, each section and file will be manually reviewed and cleaned up as needed.
Once the conversion is complete, we will start taking a look at the overall structure of the documentation and see what changes need
to be made for consistency, clarity, and ease of understanding.
## Requirements
To convert, pandoc is required. To install it, see .
## Next Steps:
- [x] Build converter script to convert all files from rst to md
- [ ] Modify converter to insert code samples and remove unnecessary files.
- [ ] Review and clean up converted files
- [ ] Review and clean up overall structure of documentation
- [ ] Standardize how pages are written to include cohesive structure and examples
## Commands:
### Converting all files
To convert all files from rst to md:
```bash
php ./admin/convert.php
```
> [!NOTE]
> This will first delete all files and directories in the `./docs` directory, except for the `assets` directory,
which contains images and other assets used by the documentation.
You can also run conversion with [filters](./admin/how_to_use_filters):
```bash
php ./admin/convert-with-filters.php
```
### Previewing the converted files
See the [How to Build Docs](./admin/how_to_build_docs.md) document for instructions on building and previewing the converted files.