Technical Writing Mentorship Program

Please nobody should push the public folder to github from your local and ensure it is in your .gitignore

Welcome to the Technical Writing Course repository. This repository contains all the materials, documentation, and resources for the Technical Writing Mentorship Program's course on technical writing, Developer documentation, and API documentation.

This repository contains modules for the Technical Writing Mentorship Program's documentation course.

Getting Started

Prerequisites

To work with this repository, you will need to have the following tools installed on your local machine:

• Git
• Node.js (which includes npm)
• Hugo (if using Hugo for static site generation)

Clone the Repository

To get started, clone the repository to your local machine using the following command:

git clone https://github.com/Technical-writing-mentorship-program/Technicalwritingcourse.git

Navigate to the Project Directory

Once the repository is cloned, navigate to the project directory:

cd Technicalwritingcourse

Development Build

Using npm

To run a development build for testing purposes, use the following npm command:

npm run dev

This will start a local server. You can view the project in your browser at http://localhost:1313.

Using Hugo

If you are working with Hugo, you can start a development server using the following command:

hugo server

Hugo will start a local server, and you can view the site in your browser at http://localhost:1313.

How to contribute to this project

This project is open to contributions from the community. If you would like to contribute to this project, please follow the steps in our contributing guide.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Contact

If you have any questions or need further assistance, feel free to open an issue in this repository or contact the project maintainers directly.

Happy writing!