Aller au contenu

Documentation scientifique - avec Konnect

Konnect vous propose de créer une documentations scientifique gratuite et en moins de 5 minutes. Cette technologie repose sur jupyter book pour l'essentiel.

-- voir exemples Jupyter Book

Site Web ou Documentation scientifique ?

Pour un projet il s'agit de créer une documentation ou une documentation scientifique. Il n'est pas possible d'attribuer les deux pour un même projet Konnect.

-- Astuce : Pour vos projets nécessitants les deux alors créer un projet mon_projet_site et mon_projet

Nous vous proposons de suivre les quatres étapes suivantes afin de créer votre documentation :

Création et initialisation

Dans Konnect taper successivement les commandes suivantes :

  • k01
  • 25 pour créer une documentation scientifique`

Si vous n'avez pas de projet chargé, alors ouvrez un projet k01 > 1

Création en local terminée

Visualisation et modifications

Afin de visualiser votre documentation, taper successivement les commandes suivantes :

  • k01
  • 9 pour initialiser et construire votre documentation
  • enfin remonter le fil légerement et faite Ctrl + Clic sur Consulter votre documentation en local

Pour modifier votre documentation, taper successivement les commandes suivantes :

  • k01
  • 10 et attendre que la page de jupyter lab s'ouvre.

Documentation prête

Publication de votre documentation

Prérequis - avoir un répertoire en ligne

Pour publier votre documentation en ligne, votre projet actuel doit avoir répertoire distant. Si à côté de dossier local vous avez Dépôt en ligne alors vous pouvez continuer, sinon :

  • Taper k02
  • puis 1 pour créer un répertoire.

Pour publier votre documentation en ligne, rien de plus simple, il suffit de taper :

  • k01
  • 12 pour publier en ligne

Votre documentation est en ligne

Pour consulter votre documentation en ligne, taper l'adresse suivante :

-- https://<user_name_github>.github.io/<nom_repertoire_github>