इस प्रोजेक्ट के बारे में

Folio को एक Markdown फॉर्मेट और टूल के सेट के रूप में प्रस्तुत किया गया है, जिसका उपयोग उस दस्तावेज़ के भीतर प्रोग्राम लिखने के लिए किया जाता है जो उसे समझाता है। एक दस्तावेज़ YAML हेडर के साथ शुरू हो सकता है जिसमें format, id, type, status और tangle root जैसे फ़ील्ड होते हैं। कोड ब्लॉक्स को नाम दिया जा सकता है और वे एक टारगेट फ़ाइल निर्दिष्ट कर सकते हैं। Tangling एक दस्तावेज़ के कोड ब्लॉक्स को सोर्स फ़ाइलों में एकत्र करता है, प्रत्येक फ़ाइल के कमेंट स्टाइल में एक जनरेटेड हेडर लिखता है, और एक tangle-map साइडकार रिकॉर्ड करता है जो दिखाता है कि किस चंक ने कौन सी फ़ाइल बनाई। चंक्स को एक लाइन पर ब्लॉक रेफरेंस रखकर स्प्लिस किया जा सकता है, जिससे वह ब्लॉक रेफरेंस के इंडेंटेशन पर पेस्ट हो जाता है। Weaving उसी दस्तावेज़ को पढ़ने के लिए एक पेज के रूप में रेंडर करता है। Checker दस्तावेज़ के मेटाडेटा को दिए गए वोकैबुलरी या दस्तावेज़ों में परिभाषित वोकैबुलरी के विरुद्ध वैलिडेट करता है। प्रदान की गई वोकैबुलरी दस्तावेज़ों, सॉफ़्टवेयर और उनके संबंधों का वर्णन करती है, और इसे विस्तारित या बदला जा सकता है। दस्तावेज़ Turtle या YAML ब्लॉक्स का उपयोग करके कॉन्सेप्ट्स और इंस्टेंस घोषित कर सकते हैं। Publications एक बड़े संग्रह से दस्तावेज़ों और कोड का चयन करते हैं और एक स्टैंडअलोन रिपॉजिटरी तैयार करते हैं, जिसके मूल PROVENANCE.json में रिकॉर्ड किए जाते हैं और चयन के बाहर के crates पर निर्भरता को अस्वीकार किया जाता है। यह रिपॉजिटरी इसी तरह तैयार की गई है और इसमें टूल के साथ-साथ वे सोर्स दस्तावेज़ भी शामिल हैं जिन्होंने इसे जनरेट किया। जनरेटेड Rust को कमिट किया गया है, इसलिए एक फ्रेश क्लोन को cargo के साथ बिल्ड किया जा सकता है। गाइड्स इंटीग्रेशन, मौजूदा कोड की ओर दस्तावेज़ों को इंगित करने और वर्तमान सीमाओं को कवर करते हैं। CI पुनः tangle कर सकता है और यदि ट्री बदलता है तो फेल हो सकता है। लाइसेंस MIT है, और डिपेंडेंसी लाइसेंस अपनी शर्तों को बनाए रखते हैं। README एक उदाहरण प्रॉम्प्ट भी देता है जिससे किसी एजेंट से यह पूछा जा सके कि Folio किसी प्रोजेक्ट में कहाँ मदद कर सकता है।