diff --git a/content/en/_index.md b/content/en/_index.md index 60cee99..303e1fa 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -1,79 +1,42 @@ --- -title: Goldydo +title: GITx +linkTitle: Docs --- {{< blocks/cover title="Welcome to GITx" image_anchor="top" height="full" >}} - + Learn More - + Download -

Porridge temperature assessment — in the cloud!

-{{< blocks/link-down color="info" >}} +

A TUI to help you learn and use Git!

{{< /blocks/cover >}} {{% blocks/lead color="primary" %}} -Goldydocs provides a single web UI providing visibility into porridge -temperature, chair size, and bed softness metrics! You can even find out who's -been eating **your** porridge. - -(Sadly, Goldydocs isn't a real project, but you can use this site as an example -to create your own real websites with [Docsy](https://docsy.dev)) +GITx provides a single terminal UI providing visibility into your git workflow, +and providing a guided experience to learning and using Git. {{% /blocks/lead %}} {{% blocks/section color="dark" type="row" %}} -{{% blocks/feature icon="fa-lightbulb" title="New chair metrics!" %}} -The Goldydocs UI now shows chair size metrics by default. +{{% blocks/feature icon="fa-lightbulb" title="Interactive Learning" %}} +The GITx UI helps you visualize your git history and workflow. Please follow this space for updates! {{% /blocks/feature %}} -{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}} -We do a [Pull Request](https://github.com/google/docsy-example/pulls) contributions workflow on **GitHub**. New users are always welcome! +{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/gitxtui/gitx" %}} +We do a [Pull Request](https://github.com/gitxtui/gitx/pulls) contributions workflow on **GitHub**. New users are always welcome! {{% /blocks/feature %}} -{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}} -For announcement of latest features etc. +{{% blocks/feature icon="fab fa-discord" title="Join our Discord!" url="https://discord.com/invite/2KgPQpejGv" %}} +For announcements, support, and to join the community. {{% /blocks/feature %}} -{{% /blocks/section %}} - - -{{% blocks/section %}} -This is the second section -{.h1 .text-center} -{{% /blocks/section %}} - - -{{% blocks/section type="row" %}} - -{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}} -Get the Goldydocs app! -{{% /blocks/feature %}} - -{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" - url="https://github.com/google/docsy-example" %}} -We do a [Pull Request](https://github.com/google/docsy-example/pulls) -contributions workflow on **GitHub**. New users are always welcome! -{{% /blocks/feature %}} - -{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" - url="https://twitter.com/GoHugoIO" %}} -For announcement of latest features etc. -{{% /blocks/feature %}} - -{{% /blocks/section %}} - - -{{% blocks/section %}} -This is the another section -{.h1 .text-center} -{{% /blocks/section %}} - +{{% /blocks/section %}} \ No newline at end of file diff --git a/content/en/about/featured-background.png b/content/en/about/featured-background.png index d6c4046..deab4e2 100644 Binary files a/content/en/about/featured-background.png and b/content/en/about/featured-background.png differ diff --git a/content/en/about/index.md b/content/en/about/index.md index d5674d0..5a97787 100644 --- a/content/en/about/index.md +++ b/content/en/about/index.md @@ -14,7 +14,7 @@ menu: {main: {weight: 10}}

- A sample site using the Docsy Hugo theme. + A Terminal User Interface for Git.

@@ -24,10 +24,8 @@ menu: {main: {weight: 10}} {{% blocks/lead %}}
- Goldydocs is a sample site using the Docsy - Hugo theme that shows what it can do and provides you with a template site structure.
- It’s designed for you to clone and edit as much as you like.
- See the different sections of the documentation and site for more ideas. + GITx is a TUI helper for learning and using Git, inspired by lazygit.
+ It’s designed to be a helpful companion for both beginners and experienced Git users.
{{% /blocks/lead %}} @@ -38,7 +36,7 @@ menu: {main: {weight: 10}}

Discover More Features

- Explore the documentation and learn how to customize your own Docsy-powered site.
+ Explore the documentation and learn how to use GITx.
Get Started

@@ -50,7 +48,7 @@ menu: {main: {weight: 10}}

Contribute, ask questions, or share your experience with others.
- Visit Docsy on GitHub + Visit GITx on GitHub

{{% /blocks/section %}} \ No newline at end of file diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md new file mode 100644 index 0000000..157c1e8 --- /dev/null +++ b/content/en/docs/_index.md @@ -0,0 +1,27 @@ +--- +title: Documentation +linkTitle: Docs +menu: + main: + weight: 20 +--- + +{{% pageinfo %}} +This is the documentation for GITx, a TUI helper for learning and using Git. +{{% /pageinfo %}} + +GitX is a Terminal User Interface (TUI) helper designed to simplify the process of learning and using Git, the most widely used version control system (VCS). Instead of typing long and often confusing commands, GitX presents a more guided and interactive interface that helps beginners understand Git concepts while still working inside the terminal. It is especially useful for students, new developers, or anyone who wants to strengthen their Git fundamentals by not only providing an easy access to all the git functions but also educating about doing all the said exercises manually. + +## Why do I want it? + +This tool significantly boosts your knowledge on the integration and working of `git` and `github` (NOT THE SAME THING) and for seasoned users, provides an efficient way to navigate through the respective functions. + +## Disclaimer: + +Although `gitx` provides an easier and more efficient way to access all the functions with simple keystrokes. It is still not recommended for beginners who are looking for a way-around those functions, this documentation involves theoretical explanation of each and every function who's knowledge will be necessary before they're used in the professional world. + +## Where should I go next? + +- [Getting Started](./overview): Get started with GITx +- [Installation](./docs/getting-started/installation): Install GITx +- [Tutorials](./docs/tutorials/): Check out some tutorials for git! \ No newline at end of file diff --git a/content/en/docs/getting-started/installation.md b/content/en/docs/getting-started/installation.md new file mode 100644 index 0000000..c4a4cd0 --- /dev/null +++ b/content/en/docs/getting-started/installation.md @@ -0,0 +1,43 @@ +--- +title: Installation +weight: 2 +--- + +## Installation Script + +The easiest way to install `gitx` is by using the installation script. Open your terminal and run the following command: + +```bash +curl -sSL [https://raw.githubusercontent.com/gitxtui/gitx/master/install.sh](https://raw.githubusercontent.com/gitxtui/gitx/master/install.sh) | bash +``` + +This script will automatically detect your operating system and architecture, download the latest release of gitx, and install it to /usr/local/bin. + +## Manual Installation + +If you prefer to install gitx manually, you can download the latest release from the GitHub Releases page. + +Download the appropriate .tar.gz file for your operating system and architecture. +Extract the archive: + +```Bash +tar -xzf gitx_*.tar.gz +``` + +Move the gitx binary to a directory in your $PATH, for example: + +```Bash +sudo mv gitx /usr/local/bin/ +``` + +To verify that gitx is installed correctly, change to a directory containing a git repo and run: + +```Bash +gitx +``` + + + +## Where should I go next? + +- [Tutorials](/docs/docs/tutorials/): Check out some tutorials for git! \ No newline at end of file diff --git a/content/en/docs/overview.md b/content/en/docs/overview.md index 5133f3a..2d48755 100644 --- a/content/en/docs/overview.md +++ b/content/en/docs/overview.md @@ -4,11 +4,9 @@ description: Here's where your user finds out if your project is for them. weight: 1 --- -{{% pageinfo %}} - + The Overview is where your users find out about your project. Depending on the size of your docset, you can have a separate overview page (like this one) or @@ -33,5 +31,5 @@ Although `gitx` provides an easier and more efficient way to access all the func Give your users next steps from the Overview. For example: -- [Getting Started](/docs/getting-started/): Get started with GITx -- [Examples](/docs/examples/): Check out some example code! +- [Installation](/docs/docs/getting-started/installation): Install GITx +- [Tutorials](/docs/docs/tutorials/): Check out some tutorials for git! \ No newline at end of file diff --git a/hugo.yaml b/hugo.yaml index ea9a738..53c590e 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -1,24 +1,15 @@ -baseURL: https://example.docsy.dev -title: Goldydocs - -# cSpell:ignore goldmark github hugo readingtime docsy subdir lastmod pygments linenos catmullrom norsk gu +baseURL: https://gitxtui.github.io/docs +title: GITx # Language settings contentDir: content/en defaultContentLanguage: en -defaultContentLanguageInSubdir: false -# Useful when translating. -enableMissingTranslationPlaceholders: true enableRobotsTXT: true # Will give values to .Lastmod etc. enableGitInfo: true -# Comment out to disable taxonomies in Docsy -# disableKinds: [taxonomy] - -# You can add your own taxonomies taxonomies: tag: tags category: categories @@ -26,10 +17,7 @@ taxonomies: # Highlighting config pygmentsCodeFences: true pygmentsUseClasses: false -# Use the new Chroma Go highlighter in Hugo. pygmentsUseClassic: false -# pygmentsOptions: "linenos=table" -# See https://help.farbox.com/pygments.html pygmentsStyle: tango # Configure how URLs look like per section. @@ -42,33 +30,6 @@ imaging: quality: 75 anchor: smart -# Language configuration -languages: - en: - languageName: English - title: GITx - params: - description: A Docsy example site - # cSpell:disable - 'no': - languageName: Norsk - contentDir: content/no - title: Gulldoks - params: - description: Docsy er operativsystem for skyen - time_format_default: 02.01.2006 - time_format_blog: 02.01.2006 - fa: - languageDirection: rtl - languageName: "فارسی (Persian)" - contentDir: content/fa - title: "اسناد گلدی" - params: - description: "یک نمونه برای پوسته داکسی" - time_format_default: 2006.01.02 - time_format_blog: 2006.01.02 - # cSpell:enable - markup: goldmark: parser: @@ -78,13 +39,7 @@ markup: unsafe: true highlight: noClasses: false - # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html style: tango - styleDark: hugo book - # Uncomment if you want your chosen highlight style used for code blocks without a specified language - # guessSyntax: true - -# Everything below this are Site Params # Comment out if you don't want the "print entire section" link enabled. outputs: @@ -92,136 +47,53 @@ outputs: params: taxonomy: - # set taxonomyCloud = [] to hide taxonomy clouds taxonomyCloud: [tags, categories] - - # If used, must have same length as taxonomyCloud taxonomyCloudTitle: [Tag Cloud, Categories] - - # set taxonomyPageHeader = [] to hide taxonomies on the page headers taxonomyPageHeader: [tags, categories] privacy_policy: https://policies.google.com/privacy - # First one is picked as the Twitter card image if not set on page. - # images: [images/project-illustration.png] - - # Menu title if your navbar has a versions selector to access old versions of your site. - # This menu appears only if you have at least one [params.versions] set. version_menu: Releases - - # Flag used in the "version-banner" partial to decide whether to display a - # banner on every page indicating that this is an archived version of the docs. - # Set this flag to "true" if you want to display the banner. - archived_version: false - - # The version number for the version of the docs represented in this doc set. - # Used in the "version-banner" partial to display a version number for the - # current doc set. version: 0.0 + url_latest_version: https://github.com/gitxtui/gitx/releases - # A link to latest version of the docs. Used in the "version-banner" partial to - # point people to the main doc site. - url_latest_version: https://example.com - - # Repository configuration (URLs for in-page links to opening issues and suggesting changes) - github_repo: https://github.com/google/docsy-example - - # An optional link to a related project repo. For example, the sibling repository where your product code lives. - github_project_repo: https://github.com/google/docsy - - # Specify a value here if your content directory is not in your repo's root directory - # github_subdir: "" - - # Uncomment this if your GitHub repo does not have "main" as the default branch, - # or specify a new value if you want to reference another branch in your GitHub links - github_branch: main - - # Google Custom Search Engine ID. Remove or comment out to disable search. - gcs_engine_id: d72aa9b2712488cc3 - - # Enable Lunr.js offline search - offlineSearch: false - - # Enable syntax highlighting and copy buttons on code blocks with Prism - prism_syntax_highlighting: false + github_repo: https://github.com/gitxtui/docs + github_project_repo: https://github.com/gitxtui/gitx + github_branch: master copyright: - authors: Docsy Authors | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) | - from_year: 2018 + authors: gitxtui | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) | + from_year: 2025 - # User interface configuration ui: showLightDarkModeMenu: true - # Set to true to disable breadcrumb navigation. breadcrumb_disable: false - # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar navbar_logo: true - # Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage. navbar_translucent_over_cover_disable: false - # Enable to show the side bar menu in its compact state. sidebar_menu_compact: true - # Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) sidebar_search_disable: false - - # Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. - # This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. - # If you want this feature, but occasionally need to remove the "Feedback" section from a single page, - # add "hide_feedback: true" to the page's front matter. feedback: enable: true - # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). 'yes': >- - Glad to hear it! Please tell us how we can improve. + Glad to hear it! Please tell us how we can improve. 'no': >- - Sorry to hear that. Please tell us how we can improve. - - # Adds a reading time to the top of each doc. - # If you want this feature, but occasionally need to remove the Reading time from a single page, - # add "hide_readingtime: true" to the page's front matter - readingtime: - enable: false + Sorry to hear that. Please tell us how we can improve. links: - # End user relevant links. These will show up on left side of footer and in the community page if you have one. - user: - - name: User mailing list - url: https://example.org/mail - icon: fa fa-envelope - desc: Discussion and help from your fellow users - - name: Twitter - url: https://example.org/twitter - icon: fab fa-twitter - desc: Follow us on Twitter to get the latest news! - - name: Stack Overflow - url: https://example.org/stack - icon: fab fa-stack-overflow - desc: Practical questions and curated answers - # Developer relevant links. These will show up on right side of footer and in the community page if you have one. developer: - name: GitHub - url: https://github.com/google/docsy + url: https://github.com/gitxtui/gitx icon: fab fa-github desc: Development takes place here! - - name: Slack - url: https://example.org/slack - icon: fab fa-slack - desc: Chat with other project developers - - name: Developer mailing list - url: https://example.org/mail - icon: fa fa-envelope - desc: Discuss development issues around the project + - name: Discord + url: https://discord.com/invite/2KgPQpejGv + icon: fab fa-discord + desc: Join the community on Discord! module: - # Uncomment the next line to build and serve using local docsy clone declared in the named Hugo workspace: - # workspace: docsy.work hugoVersion: extended: true min: 0.146.0 imports: - path: github.com/google/docsy - disable: false - -caches: - images: - dir: :cacheDir/images \ No newline at end of file + disable: false \ No newline at end of file