Habiplex Help Center

website·Indexed 31 days ago

https://ayuda.habiplex.app/

Documentation and tutorials for Habiplex, featuring guides on accounting processes such as cash receipts (recibos de caja), as well as technical documentation for site management using Docusaurus, including page creation, i18n translation, and version control.

Tokens
2.4K
Snippets
19
Records
24
Agent score
0%

What's inside Habiplex

  1. Create a blog post in Docusaurus

    Docusaurus automatically generates a dedicated page for every blog post file created, as well as a blog index page, a tag system, and an RSS feed. To create a new post, create a markdown file within the blog/ directory. The filename typically follows a date-based naming convention (e.g., YYYY-MM-DD-title.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.
  2. Insert links and images in Markdown

    Docusaurus supports standard Markdown syntax for links and images. Links can use absolute URL paths or relative file paths. Images can be referenced via absolute paths (relative to the static/ directory) or relative paths (colocated with the Markdown file).
    <!-- Link to a page -->
    [Create a page](/create-a-page)
    [Create a page](./create-a-page.md)
    
    <!-- Image from static directory -->
    ![Docusaurus logo](/img/docusaurus.png)
    
    <!-- Image relative to current file -->
    ![Docusaurus logo](./img/docusaurus.png)
  3. Install and initialize a new Docusaurus site

    To create a new Docusaurus site using the classic template, you must have Node.js version 18.0 or above installed. Run the initialization command in your terminal (Command Prompt, Powershell, or Bash) to generate the project structure and install all necessary dependencies.
    npm init docusaurus@latest my-website classic
  4. Run the Docusaurus development server

    After generating a site, navigate into the project directory and start the local development server. This builds the website locally and serves it at http://localhost:3000/. The server supports hot-reloading, meaning changes made to files (such as docs/intro.md) will be reflected automatically in the browser.
    cd my-website
    npm run start
  5. Translate documentation files for a specific locale

    To translate a document, copy the original file from the docs directory into the corresponding locale folder within the i18n directory. The path structure follows the plugin name and current version.
    # Create the directory for the French translation
    mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
    
    # Copy the document to the translation folder
    cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
  6. Create a new documentation version in Docusaurus

    Use the Docusaurus CLI to snapshot the current state of your docs folder into a versioned release. This process copies the docs folder into a new directory within versioned_docs/ and creates or updates a versions.json file to track the version history.

    After creating a version (e.g., '1.0'), the site will host two sets of docs:

    • The released version (e.g., 1.0) at /docs/.
    • The upcoming, unreleased version (labeled as current) at /docs/next/.
    npm run docusaurus docs:version 1.0
  7. Build a Docusaurus site for production

    Docusaurus is a static-site-generator that produces static HTML, JavaScript, and CSS files. To generate these production files, run the build command. The resulting static assets are output to the build folder.
    npm run build
  8. Update content for specific documentation versions

    Docusaurus separates content by version using the file system. To update a specific version, edit the file in its corresponding versioned folder. To update the upcoming/unreleased version, edit the file in the main docs folder.

    Example mapping:

    • versioned_docs/version-1.0/hello.md $\rightarrow$ updates http://localhost:3000/docs/hello
    • docs/hello.md $\rightarrow$ updates http://localhost:3000/docs/next/hello
  9. Use MDX to embed React components in Markdown

    Docusaurus supports MDX, which allows you to export and use React components directly within your Markdown files to create interactive documentation.
    export const Highlight = ({children, color}) => (
      <span
        style={{
          backgroundColor: color,
          borderRadius: '20px',
          color: '#fff',
          padding: '10px',
          cursor: 'pointer',
        }}
        onClick={() => {
          alert(`You clicked the color ${color} with label ${children}`)
        }}>
        {children}
      </span>
    );
    
    This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
  10. Create a new document in Docusaurus

    In Docusaurus, documents are groups of pages connected via a sidebar, previous/next navigation, and versioning. To create a new document, create a Markdown file within the docs directory. For example, creating docs/hello.md will make the document available at the /docs/hello URL path.
    # Hello
    
    This is my **first Docusaurus document**!
  11. Manage cash receipts in Habiplex

    Cash receipts (Recibos de caja) are documents that support money entries into the company. They are automatically generated whenever an income entry is registered, such as a payment for a sales invoice or other income associated with accounting accounts. To manage these receipts, navigate to the 'Ingresos' (Income) menu and select 'Pagos recibidos' (Payments received).