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

Add multilingual docs #163

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Conversation

NikhilKalloli
Copy link
Contributor

@NikhilKalloli NikhilKalloli commented Oct 22, 2024

Hey @KoljaB
Addresses #152
This pull request significantly enhances the documentation for the RealtimeTTS library, adding detailed sections on configuration, usage, installation, and contributing. The most important changes include support for Multilingual docs.

Documentation Enhancements:

  1. Created Documentation Structure:
    Added a docs folder containing documentation in two languages: English and French

  2. Added mkdocs.yml:
    Configured the mkdocs.yml file to manage the documentation structure and navigation for both languages.

To run locally
pip install mkdocs mkdocs-material mkdocs-static-i18n
mkdocs serve
Also this docs can be easily deployed using github pages mkdocs gh-deploy
Please review the PR and let me know any enhancements

@NikhilKalloli
Copy link
Contributor Author

Hey @KoljaB, Here are few screenshots for your referernce:
English:
English_1
English_2
French:
French_1

@KoljaB KoljaB merged commit 4327d24 into KoljaB:master Oct 23, 2024
@KoljaB
Copy link
Owner

KoljaB commented Oct 23, 2024

Looks great, thanks

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.

2 participants