Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • gh-main
  • raw_printing
  • old
4 results

documentation

  • Clone with SSH
  • Clone with HTTPS
  • Charles-Henri Decultot's avatar
    Charles-Henri Decultot authored
    Studio
    
    See merge request !106
    23913523
    History

    Netlify Status

    Site web pour la documentation de Dokos

    Live website

    Installation locale

    Commandes

    Paramétrage

    Installez les dépendances:

    # npm
    npm install
    
    # pnpm
    pnpm install
    
    # yarn
    yarn install
    
    # bun
    bun install

    Serveur de développement

    Démarrez un serveur de développement à l'adresse http://localhost:3000:

    # npm
    npm run dev
    
    # pnpm
    pnpm run dev
    
    # yarn
    yarn dev
    
    # bun
    bun run dev

    Production

    Publier l'application pour la production:

    # npm
    npm run build
    
    # pnpm
    pnpm run build
    
    # yarn
    yarn build
    
    # bun
    bun run build

    Prévisualisez le site de production localement:

    # npm
    npm run preview
    
    # pnpm
    pnpm run preview
    
    # yarn
    yarn preview
    
    # bun
    bun run preview

    Plus d'information sur la documentation de déploiement à cette adresse.

    Composants

    Documentation Nuxt UI / Nuxt UI Pro

    Ce site est basé sur les composants de Nuxt UI et Nuxt UI Pro.

    Tous les composants sont documentés à l'adresse suivante: https://ui.nuxt.com/

    Graphiques de flux

    Il est possible d'utiliser Mermaid pour créer des graphiques de flux dans la documentation.

    La syntaxe a utiliser est la suivante:

    <mermaid>
    flowchart LR
      id1(Client)-->id2(Groupe de clients)
      id2-->id3(Paramètres des ventes)
    </mermaid>

    Tour

    La documentation dispose d'un composant Tour permettant de renvoyer les utilisateurs vers une des démo et d'ouvrir automatiquement un tour. La syntaxe a utiliser est la suivante:

    ::tour{doctype=Item demo="Mappemonde"}
    Découvrir les **Articles** sur la démo
    ::

    Propriétés:
    doctype: N'importe que DocType de Dokos présent dans la démo
    demo (Optionnel): Mappemonde ou Dokompany. Si cette propriété n'est pas définie, la valeur par défaut est Dokompany

    Lien vers la démo

    La documentation dispose d'un composant DemoLink permettant de renvoyer les utilisateurs vers une des démo. La syntaxe a utiliser est la suivante:

    ::DemoLink{path="/app/web-form/event-registration-form" demo="Mappemonde"}
    Cet exemple utilise le formulaire web _event-registration-form_
    ::

    Propriétés:
    doctype (Optionnel): N'importe que DocType de Dokos présent dans la démo
    path (Optionnel): Lien vers une page de la démo
    demo: Mappemonde ou Dokompany. Si cette propriété n'est pas définie, la valeur par défaut est Dokompany
    showTour (Optionnel): Déclenche l'ouverture automatique du Tour sur la démo
    icon (Optionnel): Une icône

    FAQ

    Il est possible d'ajouter des questions fréquentes en bas de chaque page en mettant une propriété faq dans les métadonnées de la page.
    Exemple

    ---
    title: Introduction <!-- Titre de la page -->
    faq:
      title: Questions Fréquentes <!-- Titre de la section FAQ. Apparaît au dessus des questions. -->
      items: <!-- Liste de questions/réponses -->
        - label: Do you have a free trial?
          content: We have much better than a free trial, you can use Nuxt UI Pro for free in development mode. Once you are ready to deploy your application, you can purchase a license.
          defaultOpen: true <!--Ajouter cette propriété pour que le panneau soit ouvert par défaut -->
        - label: Can I use Nuxt UI Pro for Open Source projects?
          content: Yes, you can use Nuxt UI Pro for your open source projects as well as your commercial projects as long as you don't sell Nuxt UI Pro as a product and that you don't share your license key.
        - label: What does “Unlimited minor & patch updates” include?
          content: We add new components and improvements to Nuxt UI Pro as we get new ideas and feedback, you will receive these updates for the major version you purchased. **Your license key will work forever for the major version.** We may release a major version including more advanced components and features in the future, you will be able to upgrade to this version with a generous discount.
        - label: Do you offer technical support?
          content: Once you sign up you get access to our private GitHub repository, where you can ask questions, report bugs or feature requests and get help from other customers. If you require more specialised support or consultancy, contact us at ui-pro@nuxt.com.
    ---

    Icônes

    Il est possible d'utiliser les icônes référencées sur https://icones.js.org
    Actuellement, les librairies d'icônes installées sont les suivantes:

    • heroicons
    • simple-icons
    • mdi
    • vaadin
    • uil
    • carbon
    • material-symbols
    • fluent
    • eos-icons
    • ri
    • icon-park-outline
    • ep
    • clarity
    • fontisto
    • ic
    • codicon
    • octicon
    • feather
    • logos
    • healthicons
    • gg
    • iconoir
    • system-uicons
    • fa6-solid
    • fa6-brands
    • cib
    • devicon-plain

    Si possible, essayez d'utiliser ces librairies en priorité.
    Pour l'installation de librairies additionnelles, merci de créer un ticket Github et de l'affecter à Charles-Henri.

    Bugs / Améliorations / Suggestion

    Pour toute demande ou suivi des travaux en cours, merci de créer un ticket