-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3a9f450
commit 25d6a0e
Showing
49 changed files
with
716 additions
and
1,669 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,140 +1,10 @@ | ||
| # Documents | ||
| # The Book of Guidance | ||
|
|
||
| **Documents** is a powerful **Next.js** documentation starter kit designed to simplify the process of creating high-quality, comprehensive product documentation, technical manuals and business guides. Built with **React**, **Tailwind CSS** and **TypeScript**, this starter kit provides the foundation to build your project documentation and knowledge base. | ||
|
|
||
| **Demo**: [https://rubix-documents.vercel.app/](https://rubix-documents.vercel.app/) | ||
|
|
||
| [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frubixvi%2Frubix-documents&project-name=my-documents&repository-name=my-documents&demo-title=Documents&demo-description=This%20Document%20Starter%20Kit%20is%20developed%20with%20Next.js%2C%20Tailwind%20CSS%20and%20TypeScript.%20It%20serves%20as%20a%20flexible%20and%20scalable%20foundation%20for%20building%20documentation%20websites%20or%20content-driven%20projects.&demo-url=https%3A%2F%2Frubix-documents.vercel.app%2F&demo-image=https%3A%2F%2Fgithub.com%2Frubixvi%2Frubix-documents%2Fblob%2Fmain%2Fpublic%2Fscreens%2Fscreen-1.png) | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Features](#features) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
| - [Contact](#contact) | ||
|
|
||
| ## Documentation | ||
|
|
||
| [https://docs.rubixstudios.com.au](https://docs.rubixstudios.com.au) **(In-Development)** | ||
|
|
||
| ## Development | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Clone the repository: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/rubixvi/rubix-documents.git | ||
| cd rubix-documents | ||
| ``` | ||
|
|
||
| 2. Install dependencies: | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| 3. Run the development server: | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| ``` | ||
|
|
||
| 4. Open [http://localhost:3000](http://localhost:3000) in your browser to see the project. | ||
|
|
||
| 5. **For Production:** | ||
|
|
||
| - Build the app: | ||
|
|
||
| ```bash | ||
| npm run build | ||
| ``` | ||
|
|
||
| - Start the production server: | ||
|
|
||
| ```bash | ||
| npm run start | ||
| ``` | ||
|
|
||
| - Open [http://localhost:3000](http://localhost:3000) to view the production build. | ||
|
|
||
| - **If deploying to Vercel,** the build step is automatically handled during deployment. | ||
|
|
||
| ## Usage | ||
|
|
||
| This kit can be used to create product documentation, business websites and guides. | ||
|
|
||
|  | ||
| *Main Screen* | ||
|
|
||
|  | ||
| *Document Screen* | ||
|
|
||
|  | ||
| *Document Footer* | ||
|
|
||
|  | ||
| *Document Search* | ||
|
|
||
|  | ||
| *Main Dark Mode Screen* | ||
|
|
||
|  | ||
| *Document Dark Mode Screen* | ||
|
|
||
| ## Features | ||
|
|
||
| ### Content Creation | ||
|
|
||
| - **MDX Integration**: Write docs with Markdown & JSX components. | ||
| - **Custom Components**: Reuse React components in your docs. | ||
| - **Mermaid.js Diagrams**: Create flowcharts & diagrams. | ||
| - **Math & Tables**: Include tables & LaTeX math formulas. | ||
|
|
||
| ### Navigation & Readability | ||
|
|
||
| - **Multi-level Navigation**: Nested pages for hierarchy. | ||
| - **Content Pagination**: Smooth transitions between pages. | ||
| - **Dynamic TOC**: Auto-generated table of contents. | ||
| - **Code Switcher**: Toggle & copy code snippets easily. | ||
|
|
||
| ### Code Features | ||
|
|
||
| - **Syntax Highlighting**: Theme-aware highlighting. | ||
| - **Enhanced Code Blocks**: Line highlighting & code titles. | ||
|
|
||
| ### Theming & UX | ||
|
|
||
| - **Light/Dark Modes**: Automatic theme switching. | ||
| - **SEO Optimization**: Auto-generated metadata for better ranking. | ||
| - Manage meta tags (title, description, URLs, social sharing). | ||
|
|
||
| ### Search & Future Enhancements | ||
|
|
||
| - **Advanced Search**: Fuzzy search with term highlighting. | ||
| - **AI Knowledgebase**: Future AI-powered doc tools. | ||
|
|
||
| > **Note:** AI documentation support is in development. | ||
|
|
||
| ## Contributing | ||
|
|
||
| 1. Fork the repository. | ||
| 2. Create a new branch (`git checkout -b feature-branch`). | ||
| 3. Make your changes. | ||
| 4. Commit your changes (`git commit -m 'Add some feature'`). | ||
| 5. Push to the branch (`git push origin feature-branch`). | ||
| 6. Open a pull request. | ||
| It is unknown to the learned | ||
| and known to the simple. | ||
| The wise who have seen it in every being, | ||
| on leaving this life, attain life immortal. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details. | ||
|
|
||
| ## Contact | ||
|
|
||
| For support or inquiries, contact Vincent Vu [@rubixvi](https://x.com/rubixvi) on X. | ||
|
|
||
| Rubix Studios - [https://www.rubixstudios.com.au](https://www.rubixstudios.com.au) | ||
|
|
||
| Project: [https://github.com/rubixvi/rubix-documents](https://github.com/rubixvi/rubix-documents) | ||
| This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| title: 1 September 2020 | ||
| description: Waterfalls | ||
| --- | ||
|
|
||
| The first spring rain is its own complete description. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: 2 September 2020 | ||
| description: Slow Salaat | ||
| --- | ||
|
|
||
| Paul and I walked around the garden twice today after the rain had eased up and took photos for the website. Many plants are in bloom, and many of the flowers were holding pristine drops of silver water. Truly, _rahma_ is everywhere. | ||
|
|
||
| So much happens each day, and I have so little to say about it. | ||
|
|
||
| After our walk, we sat on the benches near the pond and I fell into deeper meditation. It was around sunset, so I began doing _Maghreb_ in my imagination - not moving a muscle, but carefully following each incantation and embodied movement through its proper course. What it felt like to move through each cycle! | ||
|
|
||
| Paul looked at me afterwards and called it “windows into Reality”, which was both perfectly timed and about as well put as it can be. It’s like being totally transparent. | ||
|
|
||
| The sense of overwhelming light, being broken into a release and relief beyond measure, and then the completely full compassion required to come back and keep pretending: there is no way to quantify all this in any sentence. | ||
|
|
||
| We walked home quietly and made some coffee. The full moon finally broke through the clouds right as we stepped out of the kitchen, steaming cups cradled in our hands. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: 3 September 2020 | ||
| description: The Mirror | ||
| --- | ||
|
|
||
| We spent most of the day today with Aaron working on the website. He’s such a gentle and loving soul. I care for him deeply and unexpectedly. | ||
|
|
||
| While he took a call, Paul and I went for another walk. We did our usual round and came back to the benches once again to sit quietly. Each day is fresh and unique and utterly itself, so I wasn’t trying to repeat or go back to what had happened yesterday. It felt softer and more gentle and I just washed away in the birdsong and quiet breeze. | ||
|
|
||
| At some stage in the stillness, it was as if the gate of ego opened up. I saw this which must die for what it is and felt a wave of gratitude wash over me. It wasn’t overwhelming like yesterday, but it had somehow the same depth to it. I’m just incredibly grateful to be who I am, with all my flaws and limitations and the endless arrogance and ego I have to constantly catch myself in. | ||
|
|
||
| After this, I sat quietly waiting for Paul. We both eventually got up to meet Aaron, and SFH appeared at the same time, “on a mission.” He looked at us both, thanked us for being there, and made the point that whatever we do, we ultimately do it for our own self. This felt particularly apposite given what had just happened on the benches. He went on to make the point that all we have to do is get rid of the illusion that we have got something. We may have understood a tiny, little, insignificant bit, but the truth is that whatever we think we’ve got, it’s really got us. We thank the ego for holding this small little bit, and then we dissolve laughing into that which can never be known by the limited and conditioned mind. | ||
|
|
||
| He then had a striking exchange with Aaron, which went something like this: | ||
|
|
||
| Aaron: The website is beginning to look good and we’re making great progress. \ | ||
| SFH: Good. It could’ve been done a long time ago though. \ | ||
| Aaron: No, it couldn’t have Shaykhna. You were not ready. \ | ||
| SFH: I was not ready!? No. The people were not ready for a true mirror. ‘Do you know that you don’t exist? Have you realised yet that you are an illusion?’ Nobody could handle that. | ||
|
|
||
| The conversation meandered on a bit, with SFH asking Aaron to get him some “sugar melons”. There is no such thing, but “it’s really about hope. We need hope to occupy the mind, so that it can be satisfied and come to neutrality. Only then can we go beyond.” He also told a story about Dr Z bringing him some watermelons (a summer fruit) on winter solstice and bemoaned this idiocy. He joked about how he couldn’t even eat them, because they’re God (referring to an old Sufi story about a god-king melon). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| title: 4 September 2020 | ||
| description: Silent Dhikr and a Web of Wonder | ||
| --- | ||
|
|
||
| Paul and I shared a beautiful lunch today which we made. Then I sat quietly in the sun for a while and, after digesting a bit, went upstairs for *Jumah*. My intention was clear, but not a word or even a feeling. Not even ‘truth’ any more. | ||
|
|
||
| I then sat outside as we rose into the afternoon sun, slowly shifting its warmth across the balcony and did a silent dhikr. I remember how I died. | ||
|
|
||
| I exploded in the light, and the wind sang through the palm fronds, and two fish eagles called to each other in their singular, signature tune of African yearning. I think that - like the owls - they’re getting ready to nest and procreate. | ||
|
|
||
| I understand nothing. Everything is perfect. | ||
|
|
||
| *"The Lords of love are in love ensnared, \ | ||
| Bewildered"* - Ibn 'Arabi | ||
|
|
||
| Later in the day, Aaron, Mary, Paul and I met with SFH to review the website. There is so little to say about the hour and half we got to spend together. I sat next to SFH for the duration of the meeting, walking him through the work we’ve done, listening to various bursts and beams from him, recording what I could, and generally just flowing in the love and presence which permeates everything at all times, but is particularly obvious around him. | ||
|
|
||
| Most of what he related had to do with the ever-lasting light within every heart, the unnecessary nature of any path or religion or ritual, and the need for a balance between head and heart. The rest of what we worked through can be found in [this commit](https://github.com/SFH-Foundation/sfhfoundation/commit/d7db5cacefd13b9a54ab110bb68e3dba6c4c8af8) and in the two audio recordings I was gifted. | ||
|
|
||
| There’s only one other story worth relating here. At one stage, he looked at me and said, “It’s all transient. Everything is transient: he, she, you, me. Every I passes on. Yet I know this because there is a permanent light whose shadow I am. I know my temporary self because of the eternal soul. **It’s so simple**!” | ||
|
|
||
| “Go back to zero and be \ | ||
| at One.” | ||
|
|
||
| --- | ||
|
|
||
| Later still, the now-waning moon peeking out occasionally from behind more clouds, Paul and I sat quietly on the downstairs balcony beneath the chandelier. He seemed to be a bit down over dinner (Mary’s veggie soup, bread, halloumi and SFH’s gift of tulsi, which is entirely unlike anything I have ever tasted before), and I felt the desire to be transparent again. | ||
|
|
||
| However, there is a great subtlety in this: it’s not you pushing all your own illusions and shadows onto others: it is a transparency that is contained. On realising this, *ayat al-nur* came, and there is nothing more to be said. | ||
|
|
||
| We cannot ever deny this world, nor can we hastily and without care return our life in it to its source. However, it is not attachment to this world (about which we are neutral) which makes us hesitate: it is recognition of the unmeasurable value of the gift of a life in it. You can only give it back once you know its infinite worth, have tasted the joy of death, and are entirely content if it is received or if you are told to keep waking for a little while longer. |
Oops, something went wrong.