foam

Schaum

? Dies ist ein Frühphasenprojekt unter Rapid Development. Für Updates schließen Sie sich der Schaum -Community -Zwietracht an!

Foam ist ein persönliches Wissensmanagement und ein Sharing -System, das von ROAM -Forschung inspiriert ist und auf Visual Studio Code und GitHub basiert.

Sie können FoAM verwenden, um Ihre Forschung zu organisieren, neu zu entdeckbare Notizen aufrechtzuerhalten, Langforminhalte zu schreiben und sie optional im Web zu veröffentlichen.

Schaum ist kostenlos, Open Source und extrem erweiterbar, um Ihrem persönlichen Workflow zu entsprechen. Sie besitzen die Informationen, die Sie mit Schaum erstellen, und Sie können sie freigeben und mit jedem, den Sie möchten, daran zusammenarbeiten.

Merkmale

Graph Visualisierung

Sehen Sie, wie Ihre Notizen über einen Diagramm mit dem Befehl Foam: Show Graph angeschlossen werden.

Verknüpfung Autokapostion

Schaum hilft Ihnen, die Verbindungen zwischen Ihren Notizen und Ihren Platzhaltern zu erstellen.

Synchronisierungslinks in der Datei umbenennen

Foam aktualisiert die Links auf umbenannte Dateien, sodass Ihre Notizen konsistent bleiben.

Einzigartige Kennungen über Verzeichnisse hinweg

Foam unterstützt Dateien mit demselben Namen in mehreren Verzeichnissen. Es wird die erforderliche Mindestkennung verwendet und sogar melden und Ihnen helfen, vorhandene mehrdeutige Wikilinks zu reparieren.

Link -Vorschau und Navigation

Gehen Sie zur Definition, sehen Sie sich an Referenzen

Sehen Sie, wohin in Ihrer Wissensbasis auf eine Notiz verwiesen wird.

Navigation in Vorschau

Navigieren Sie Ihre gerenderten Notizen im VS -Code -Vorschau.

Hinweis Einbettung

Betten Sie den Inhalt aus anderen Notizen ein.

Unterstützung für Abschnitte

Schaum unterstützt die Autoperation, Navigation, Einbettung und Diagnose für Notizabschnitte. Verwenden Sie einfach die Standard -Wiki -Syntax von [[resource#Section Title]] .

Link alias

Schaum unterstützt das Aliasing Link, sodass Sie einen [[wikilink]] oder einen [[wikilink|alias]] haben können.

Vorlagen

Verwenden Sie benutzerdefinierte Vorlagen, um die Wiederholung von Arbeiten an Ihren Notizen zu vermeiden.

Backlinks -Panel

Überprüfen Sie schnell, welche Notizen auf die aktuell aktive Notiz verweisen. Sehen Sie für jedes Ereignis den Kontext, in dem es lebt, sowie eine Vorschau der Notiz.

Tag Explorer -Panel

Markieren Sie Ihre Notizen und navigieren Sie sie mit dem Tag -Explorer. Foam unterstützt auch hierarchische Tags.

Waisen und Platzhaltertafeln

Waisen sind Notizen, die weder eingehende noch ausgehende Links haben. Platzhalter baumeln Links oder Notizen ohne Inhalt. Halten Sie sie unter Kontrolle und Ihre Wissensbasis in einem besseren Zustand, indem Sie dieses Panel verwenden.

Syntax Highlight

Foam hebt Wikilinks und Platzhalter anders hervor, um Ihnen dabei zu helfen, Ihre Wissensbasis zu visualisieren.

Tägliche Anmerkung

Erstellen Sie ein Tagebuch mit täglichen Notizen.

Generieren Sie Referenzen für Ihre Wikilinks

Erstellen Sie Markdown-Referenzen für [[wikilinks]] , um Ihre Notizen in einem Nicht-Foam-Arbeitsbereich zu verwenden. Mit Referenzen können Sie auch Ihre Notizen sowohl in der Github -Benutzeroberfläche als auch in GitHub -Seiten navigieren lassen.

Befehle

• Erkunden Sie Ihre Wissensbasis mit dem Befehl Foam: Open Random Note
• Greifen Sie mit dem Befehl Foam: Open Daily Note auf Ihre tägliche Note zu.
• Erstellen Sie eine neue Notiz mit dem Foam: Create New Note
  • Dies wird in Kombination mit Notizvorlagen und dem Foam: Create New Note from Template sehr leistungsstark
• Sehen Sie sich Ihren Arbeitsbereich als angeschlossenes Diagramm mit dem Befehl Foam: Show Graph

Rezepte

Menschen verwenden Schaum auf unterschiedliche Weise für verschiedene Anwendungsfälle. Schauen Sie sich die Rezepteseite an, um sich inspirieren zu lassen!

Erste Schritte

Egal, ob Sie ein zweites Gehirn oder ein Zettelkasten bauen, ein Buch schreiben oder beim langfristigen Lernen einfach besser werden können, Foam kann Ihnen helfen, Ihre Gedanken zu organisieren, wenn Sie diese einfachen Regeln befolgen:

1. Erstellen Sie einen einzigen Schaumstoff -Arbeitsbereich für alle Ihre Kenntnisse und Forschungsergebnisse nach dem Leitfaden für [[Erste Schritte]].
2. Schreiben Sie Ihre Gedanken in Markdown -Dokumente (ich nenne sie gerne Blasen , aber das könnte mehr als ein kleines Twee sein). Diese Dokumente sollten atomar sein: Setzen Sie Dinge, die in ein einzelnes Dokument gehören, und beschränken Sie ihren Inhalt auf dieses einzelne Thema. (Quelle)
3. Verwenden Sie die Verknüpfungen und Autokompetenzen von Foam, um Ihre Gedanken zusammen mit [[wikilinks]] zu verknüpfen, und navigieren Sie zwischen ihnen, um Ihr Wissensgraphen zu erforschen.
4. Erhalten Sie einen Überblick über Ihren Foam -Arbeitsbereich mit der [[Diagrammvisualisierung]] und entdecken Sie Beziehungen zwischen Ihren Gedanken unter Verwendung von [Backlinking].

Sie können auch unsere Schaumstoffvorlage verwenden:

1. Melden Sie sich in Ihrem Github -Konto an.
2. Erstellen Sie ein GitHub-Repository aus Schaumstoff-Template. Wenn Sie Ihre Gedanken für sich behalten möchten, denken Sie daran, das Repository privat festzulegen.
3. Klonen Sie das Repository und öffnen Sie es in VS -Code.
4. Wenn Sie aufgefordert werden, empfohlene Erweiterungen zu installieren, klicken Sie auf alle auf Installieren (oder Empfehlungen anzeigen, wenn Sie sie überprüfen und einzeln installieren möchten).

Dies wird auch Foam installiert, aber wenn Sie ihn bereits installiert haben, ist das in Ordnung, stellen Sie einfach sicher, dass Sie auf der neuesten Version auf dem neuesten Stand sind.

Anforderungen

Hohe Toleranz für Software in Alpha-Qualität. Schaum ist noch in Arbeit. Seien Sie versichert, dass es Sie niemals einsperrt oder Ihre Dateien beeinträchtigen wird, aber manchmal können einige Funktionen brechen;)

Bekannte Probleme

Sehen Sie sich die Probleme in unserem Github Repo;)

Versionshinweise

Siehe den Changelog.

Erfahren Sie mehr

Besuchen Sie die veröffentlichte Version dieses Foam -Arbeitsbereichs, um Foam in Aktion zu sehen und den Rest der Dokumentation zu lesen!

Schnelle Links zu den nächsten Dokumentationsabschnitten

• Was ist in einem Schaum?
• Erste Schritte
• Merkmale
• Rufen Sie zum Abenteuer an
• Danke und Zuschreibung

Sie können auch den DOCS -Ordner durchsuchen.

Lizenz

Schaum ist unter der MIT -Lizenz lizenziert.

Beitragsleitfaden

Siehe den Beitragsleitfaden

Verhaltenskodex

Siehe den Verhaltenskodex

Mitwirkende

Vielen Dank an diese wunderbaren Menschen (Emoji -Schlüssel):

Jani Eväkallio	Joe präv	Riccardo	Janne Ojanaho	Paul Shen	Mussbacher	Mathieu DUTOUR
Michael Hansen	David Nadlinger	Fernando	Juan Gonzalez	Louie Christie	Sandro	Simon Knott
Steven	Tim	Saurav Khdoolia	Ankit Tiwari Euen	Ayush Baweja	Taichi-io	Juan F Gonzalez
Sanket Dasgupta	Nicholas Stafie	Francis Hamel	Digiguru	Chirag Singhal	Jonathan Carter	Julian Elve
Thomas Koppelaar ?	Akshay	John Lindquist	Ashwin Ramaswami	Claudio Canales	Vitaly-Pevgonen	Dmitry Shemetov
Hooncp	Martingesetze	Sean K Smith	Kevin Neely	Arief Rahmansyah	Vishesh Handa	Hitesh Kumar
Spencer Woo	ingalllos	José Duarte	Yenly	Hikerpig	Sigfried Gold	Tristan Sokol
Danil Rodin	Scott Williams	Jackiexia	John B Nelson	Asif Mehedi	Tan li	Shauna Gordon
Mike Cluck	Brandon Pugh	Max Davitt	Brian Anglin	Elswork	Léon h	Nikhil Nygaard
Mark Dixon	Joel James	Hashiguchi Ryo	Michael Overmeyer	Derrick Qin	Omar López	Robin King
Dheepak	Daniel Vg	Barabas	Engincan Veske	Paul de Raaij	Scott Bronson	Rafael Riedel
Pearcekieser	Owen Young ?	Prashanth Subrahmanyam	Jonas Sprenger	Paul	Ikko Ashimine	Memeplex
Andreid049	Yan	Jim Tittsler	Malcolm Mielle	Veesar	Bentongxyz	Brian Devries
Clifford Fajardo ?	Chris Usick	Joe Decock	Drew Tyler	Lauviah0622	Josh Dover	Phil Helm
Larry Li	Joe Taber	Woosuk Park	Daniel Murphy	Dominic d	Luca	Lloyd Jackman
sn3akiwhizper	Jonathan Berger	Daniel Wang	Liu Yongliang	Scott Akerman	Jim Graham	Zhizhen er ?
Tony Cheneau	Nicholas Latham	Tomochika Hara	Daniel Carosone	Miguel Angel Bruni Montero	Kevin Walsh	Xinglan Liu
Thomas Hegghammer	Piotr Mrzygłosz

Dieses Projekt folgt der All-Contributors-Spezifikation. Beiträge jeglicher Art willkommen!