From f5ac84e3f8952bf7d01f0defc6f7531cdbdd2693 Mon Sep 17 00:00:00 2001 From: Saad Bazaz Date: Sun, 5 Mar 2023 18:53:05 +0500 Subject: [PATCH 1/2] update docs --- docs/contribute/_category_.json | 8 + docs/contribute/core.md | 12 ++ .../img/docsVersionDropdown.png | Bin .../img/localeDropdown.png | Bin docs/contribute/improve-docs.md | 12 ++ docs/contribute/translate.md | 11 ++ docs/examples/_category_.json | 8 + docs/examples/playground.md | 7 + docs/installation.md | 30 ++++ docs/intro.md | 44 +----- docs/tutorial-basics/_category_.json | 4 +- docs/tutorial-basics/congratulations.md | 23 --- docs/tutorial-basics/create-a-blog-post.md | 34 ---- docs/tutorial-basics/create-a-document.md | 57 ------- docs/tutorial-basics/create-a-page.md | 43 ------ docs/tutorial-basics/deploy-your-site.md | 31 ---- docs/tutorial-basics/jupyter.md | 9 ++ docs/tutorial-basics/markdown-features.mdx | 146 ------------------ docs/tutorial-basics/terminal.md | 82 ++++++++++ docs/tutorial-extras/_category_.json | 7 - docs/tutorial-extras/manage-docs-versions.md | 55 ------- docs/tutorial-extras/translate-your-site.md | 88 ----------- docusaurus.config.js | 14 +- src/css/custom.css | 13 +- 24 files changed, 202 insertions(+), 536 deletions(-) create mode 100644 docs/contribute/_category_.json create mode 100644 docs/contribute/core.md rename docs/{tutorial-extras => contribute}/img/docsVersionDropdown.png (100%) rename docs/{tutorial-extras => contribute}/img/localeDropdown.png (100%) create mode 100644 docs/contribute/improve-docs.md create mode 100644 docs/contribute/translate.md create mode 100644 docs/examples/_category_.json create mode 100644 docs/examples/playground.md create mode 100644 docs/installation.md delete mode 100644 docs/tutorial-basics/congratulations.md delete mode 100644 docs/tutorial-basics/create-a-blog-post.md delete mode 100644 docs/tutorial-basics/create-a-document.md delete mode 100644 docs/tutorial-basics/create-a-page.md delete mode 100644 docs/tutorial-basics/deploy-your-site.md create mode 100644 docs/tutorial-basics/jupyter.md delete mode 100644 docs/tutorial-basics/markdown-features.mdx create mode 100644 docs/tutorial-basics/terminal.md delete mode 100644 docs/tutorial-extras/_category_.json delete mode 100644 docs/tutorial-extras/manage-docs-versions.md delete mode 100644 docs/tutorial-extras/translate-your-site.md diff --git a/docs/contribute/_category_.json b/docs/contribute/_category_.json new file mode 100644 index 0000000..eeb5ca1 --- /dev/null +++ b/docs/contribute/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Contribute", + "position": 5, + "link": { + "type": "generated-index", + "description": "Want to help the UniversalPython movement? Here are some ways." + } +} diff --git a/docs/contribute/core.md b/docs/contribute/core.md new file mode 100644 index 0000000..3ca0c34 --- /dev/null +++ b/docs/contribute/core.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 1 +--- + +# Improving UniversalPython + +There are tonnes of interesting challenges which, when solved, can make UniversalPython easier to use and more resilient: +- [ ] In-transpiler translation of sentences (e.g. translating strings) +- [ ] How can we manage imports of packages, and the functions inside of them? +- [ ] Supporting new and old versions of Python + +Feel free to share more challenges in our [GitHub Discussions](https://github.com/UniversalPython/UniversalPython/discussions). We're ready for impact. \ No newline at end of file diff --git a/docs/tutorial-extras/img/docsVersionDropdown.png b/docs/contribute/img/docsVersionDropdown.png similarity index 100% rename from docs/tutorial-extras/img/docsVersionDropdown.png rename to docs/contribute/img/docsVersionDropdown.png diff --git a/docs/tutorial-extras/img/localeDropdown.png b/docs/contribute/img/localeDropdown.png similarity index 100% rename from docs/tutorial-extras/img/localeDropdown.png rename to docs/contribute/img/localeDropdown.png diff --git a/docs/contribute/improve-docs.md b/docs/contribute/improve-docs.md new file mode 100644 index 0000000..3ca49af --- /dev/null +++ b/docs/contribute/improve-docs.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 1 +--- + +# Improving the docs + +We maintain our docs on GitHub, using Docusaurus. Some important tasks which are pending: +- [ ] Translation of the documentation to different languages +- [ ] Making it easier for people to suggest new words and add them to the dictionary +- [ ] Computer science education, via a YouTube channel or blogs, in Native languages + +Feel free to share more tasks in our [GitHub Discussions](https://github.com/UniversalPython/UniversalPython/discussions). We're ready for impact. \ No newline at end of file diff --git a/docs/contribute/translate.md b/docs/contribute/translate.md new file mode 100644 index 0000000..889fb26 --- /dev/null +++ b/docs/contribute/translate.md @@ -0,0 +1,11 @@ +--- +sidebar_position: 3 +--- + +# Translate into your language + +Are you a native speaker of a language and can contribute to making UniversalPython's keywords more accurate? Or want to add an entirely new language to UniversalPython? Look no further. + +The list of languages supported are visible [here](https://github.com/UniversalPython/UniversalPython/tree/%D9%85%D8%B1%DA%A9%D8%B2/urdupython/languages). + +Our translations are (currently) managed in the form of [YAML](https://yaml.org/) files, like [this one right here](https://github.com/UniversalPython/UniversalPython/blob/%D9%85%D8%B1%DA%A9%D8%B2/urdupython/languages/hi/hi_native.lang.yaml). Simply make one for your own language, and share it with us by opening a Pull Request on GitHub, or simply sharing it with us on email at info@grayhat.com.pk \ No newline at end of file diff --git a/docs/examples/_category_.json b/docs/examples/_category_.json new file mode 100644 index 0000000..a1f0d19 --- /dev/null +++ b/docs/examples/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Examples", + "position": 4, + "link": { + "type": "generated-index", + "description": "Learn more by checking out code examples of UniversalPython which demonstrate its capabilities." + } +} diff --git a/docs/examples/playground.md b/docs/examples/playground.md new file mode 100644 index 0000000..197960f --- /dev/null +++ b/docs/examples/playground.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Playground + +You can try out UniversalPython in our [online playground](https://universalpython.github.io). No installations required, it all runs in your browser! \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..9022892 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 2 +--- + +# Installation + +Get started with using UniversalPython. + +## Before you begin... + +You will require: +- Some basic knowledge about Python +- Python 3+ installed in your computer +- Pip 3+ installed in your computer + +> We need help in making this documentation more accessible to people of different languages, from around the world. And more easy-to-understand for complete beginners to programming. Reach out to us at info@grayhat.com.pk if you'd like to help, or drop a Pull Request at [our repo](https://github.com/UniversalPython/UniversalPython.github.io). + +## Getting Started + +Get started with UniversalPython by installing it from PyPI. Our package name is currently "urdupython" (changes to this soon!) + +``` +pip install urdupython +``` + +## Installing from source +1. Download the [UniversalPython repo](https://github.com/UniversalPython/UniversalPython/) as a ZIP, or clone it via Git. +2. Open the repo's folder in your Terminal. +3. Run ```pip install -e .``` + diff --git a/docs/intro.md b/docs/intro.md index 8a2e69d..a754662 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -2,46 +2,18 @@ sidebar_position: 1 --- -# Tutorial Intro +# Welcome -Let's discover **Docusaurus in less than 5 minutes**. +Welcome to the UniversalPython documentation! Learn more about UniversalPython, the motivation behind it, and how it works. -## Getting Started +## Our vision -Get started by **creating a new site**. +We know how hard it is to know multiple languages and get started with computer science and programming. Almost all the material you search for, all the books, videos, and even all of the major programming languages of world, are in English. Did you know that only 27% of the entire world's population knows English? How does the rest of the world learn? This is something we have yet to understand. -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. +## History -### What you'll need +UniversalPython started off as UrduPython; the idea of a young student in NUCES, Islamabad, Pakistan. The motivation is simple; programming languages have a basic syntax comprising of "keywords". If there was a basic mapping of those keywords into other languages, the people of Pakistan (a country of **77 established languages**) could learn programming much better. -- [Node.js](https://nodejs.org/en/download/) version 16.14 or above: - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. +## Progress -## Generate a new site - -Generate a new Docusaurus site using the **classic template**. - -The classic template will automatically be added to your project after you run the command: - -```bash -npm init docusaurus@latest my-website classic -``` - -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. - -The command also installs all necessary dependencies you need to run Docusaurus. - -## Start your site - -Run the development server: - -```bash -cd my-website -npm run start -``` - -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. - -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. - -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. +We went public with UniversalPython in March, 2023. We're looking for amazing maintainers and contributers, and wish to initiate a movement across the world to make programming languages and computer science education accessible to all. \ No newline at end of file diff --git a/docs/tutorial-basics/_category_.json b/docs/tutorial-basics/_category_.json index 2e6db55..ef2ff88 100644 --- a/docs/tutorial-basics/_category_.json +++ b/docs/tutorial-basics/_category_.json @@ -1,8 +1,8 @@ { - "label": "Tutorial - Basics", + "label": "Tutorial", "position": 2, "link": { "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." + "description": "5 minutes to learn the most important UniversalPython concepts." } } diff --git a/docs/tutorial-basics/congratulations.md b/docs/tutorial-basics/congratulations.md deleted file mode 100644 index 04771a0..0000000 --- a/docs/tutorial-basics/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/docs/tutorial-basics/create-a-blog-post.md b/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index ea472bb..0000000 --- a/docs/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/docs/tutorial-basics/create-a-document.md b/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index ffddfa8..0000000 --- a/docs/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -module.exports = { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/docs/tutorial-basics/create-a-page.md b/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index 20e2ac3..0000000 --- a/docs/tutorial-basics/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

- - ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/docs/tutorial-basics/deploy-your-site.md b/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee0..0000000 --- a/docs/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/docs/tutorial-basics/jupyter.md b/docs/tutorial-basics/jupyter.md new file mode 100644 index 0000000..6f74bd1 --- /dev/null +++ b/docs/tutorial-basics/jupyter.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 2 +--- + +# From Jupyter Notebook + +You can use UniversalPython directly in Jupyter notebook. + +Follow the instructions in our Jupyter Notebook [kernel repo](https://github.com/UniversalPython/urdu_python_kernel). \ No newline at end of file diff --git a/docs/tutorial-basics/markdown-features.mdx b/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 6b3aaaa..0000000 --- a/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -```md -![Docusaurus logo](/img/docusaurus.png) -``` - -![Docusaurus logo](/img/docusaurus.png) - -You can reference images relative to the current file as well, as shown in [the extra guides](../tutorial-extras/manage-docs-versions.md). - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - - ```jsx title="src/components/HelloDocusaurus.js" - function HelloDocusaurus() { - return ( -

Hello, Docusaurus!

- ) - } - ``` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - - :::tip My tip - - Use this awesome feature option - - ::: - - :::danger Take care - - This action is dangerous - - ::: - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! diff --git a/docs/tutorial-basics/terminal.md b/docs/tutorial-basics/terminal.md new file mode 100644 index 0000000..5fe88ef --- /dev/null +++ b/docs/tutorial-basics/terminal.md @@ -0,0 +1,82 @@ +--- +sidebar_position: 1 +--- + +# From the terminal + +## How to Use +1. Create a new file in a folder. +2. Write some Urdu code in this new file. +The mappings are as following: + +| Python (original) | 🇵🇰 Ur | +| ------------- | ------------- | +| ```print``` | لکھو| +| ```if``` | اگر| +| ```elif``` | ورنہاگر| +| ```else``` | ورنہ| +| ```while``` | جبتک| +| ```for``` | جو| +| ```in``` | اندر| +| ```input``` | داخله| +| ```break``` | توڑ| +| ```continue``` | جاری| +| ```pass``` | گزر| +| ```True``` | حق| +| ```False``` | باطل| +| ```is``` | ہے| +| ```class``` | طبقه| +| ```def``` | وضح| +| ```init``` | ابتدا| +| ```self``` | خود| +| ```return``` | واپس| +| ```string``` | ستلی| +| ```str``` | ستل| +| ```append``` | شامل| +| ```pop``` | نکل| +| ```and``` | اور| +| ```or``` | یا| +| ```all``` | سب| +| ```any``` | کوئ| +| ```None``` | ندارد +| ```,``` | ، | +| ```.``` | ۔| +| ```0``` | ۰| +| ```1``` | ۱| +| ```2``` | ۲| +| ```3``` | ۳| +| ```4``` | ۴| +| ```5``` | ۵| +| ```6``` | ۶| +| ```7``` | ۷| +| ```8``` | ۸| +| ```9``` | ۹| + +Find the whole list of keywords [here](./universalpython/languages/ur/ur_native.lang.yaml). Don't worry if you can't find a mapping, you can also use English Python! + +An example of a Hello World Program: +``` +print ("Hello world!") +``` +would be +``` +لکھو ("Hello world!") +``` +There are many more sample codes available [here](./universalpython/samples) + +3. Open a Terminal in the folder of this file. +4. Run the code in one command: ```universalpython ``` + +For more help, run ```universalpython --help```. For better understanding, do run the sample code files in the "samples" folder. + +## Guide +### For macOS +- Use TextEdit (default text editor) to write Urdu code. +- Activate right-to-left typing through Menu: Format->Text->Writing Direction->Right-to-Left + +### For Windows +- Download and install Notepad++. +- Right click and activate RTL (Right-to-left). + +### For Linux +Open gEdit (or any similar text-editing program), and start coding right away. \ No newline at end of file diff --git a/docs/tutorial-extras/_category_.json b/docs/tutorial-extras/_category_.json deleted file mode 100644 index a8ffcc1..0000000 --- a/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/docs/tutorial-extras/manage-docs-versions.md b/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index e12c3f3..0000000 --- a/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/docs/tutorial-extras/translate-your-site.md b/docs/tutorial-extras/translate-your-site.md deleted file mode 100644 index caeaffb..0000000 --- a/docs/tutorial-extras/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -module.exports = { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a same time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](./img/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/docusaurus.config.js b/docusaurus.config.js index e5552d4..9f2824a 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -109,16 +109,8 @@ const config = { title: 'Community', items: [ { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/docusaurus', - }, - { - label: 'Discord', - href: 'https://discordapp.com/invite/docusaurus', - }, - { - label: 'Twitter', - href: 'https://twitter.com/docusaurus', + label: 'GitHub Discussions', + href: 'https://github.com/UniversalPython/UniversalPython/discussions', }, ], }, @@ -131,7 +123,7 @@ const config = { }, { label: 'GitHub', - href: 'https://github.com/grayhatdevelopers/universalpython', + href: 'https://github.com/UniversalPython/UniversalPython', }, ], }, diff --git a/src/css/custom.css b/src/css/custom.css index 7d3e0a6..039589e 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -4,9 +4,6 @@ * work well for content-centric websites. */ - - - @import url('https://fonts.googleapis.com/css2?family=Roboto+Mono:wght@300;400&display=swap'); /* You can override the default Infima variables here. */ @@ -38,3 +35,13 @@ } +/* .hero--primary { + background: + linear-gradient(rgba(0,0,0,0.5), rgba(0,0,0,0.5)), + url(../../static/img/banner-background.png); +} */ + +[data-theme='dark'] .hero--primary { + color: white; +} + From 146bc15c6f7dcb7ab2b575c89619509f2f9b9d01 Mon Sep 17 00:00:00 2001 From: Saad Bazaz Date: Sun, 5 Mar 2023 18:58:18 +0500 Subject: [PATCH 2/2] Add missing link --- docs/contribute/translate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribute/translate.md b/docs/contribute/translate.md index 889fb26..23b3369 100644 --- a/docs/contribute/translate.md +++ b/docs/contribute/translate.md @@ -8,4 +8,4 @@ Are you a native speaker of a language and can contribute to making UniversalPyt The list of languages supported are visible [here](https://github.com/UniversalPython/UniversalPython/tree/%D9%85%D8%B1%DA%A9%D8%B2/urdupython/languages). -Our translations are (currently) managed in the form of [YAML](https://yaml.org/) files, like [this one right here](https://github.com/UniversalPython/UniversalPython/blob/%D9%85%D8%B1%DA%A9%D8%B2/urdupython/languages/hi/hi_native.lang.yaml). Simply make one for your own language, and share it with us by opening a Pull Request on GitHub, or simply sharing it with us on email at info@grayhat.com.pk \ No newline at end of file +Our translations are (currently) managed in the form of [YAML](https://yaml.org/) files, like [this one right here](https://github.com/UniversalPython/UniversalPython/blob/%D9%85%D8%B1%DA%A9%D8%B2/urdupython/languages/hi/hi_native.lang.yaml). Simply make one for your own language, and share it with us by opening a Pull Request on [our GitHub](https://github.com/UniversalPython/UniversalPython/), or simply sharing it with us on email at info@grayhat.com.pk \ No newline at end of file