Import the packages
Benefits of importing packages/documents at the top of code
import-at-top: Import lines goes at the top of the documentWe import the external packages at the start of the .ftd file and there should be no space between two imports.
Adding import statements at the top of a code document helps other programmers understand the code’s dependencies and requirements. It allows quick identification of necessary modules and libraries. Moreover, this practice prevents naming conflicts and improves code clarity, organization, and maintainability.
It is a common convention that helps improve the clarity, organization, and maintainability of the code.
-- import: <package-1> -- ds.page: title page content goes here ;; before component -- import: <package-2> package-2 component usage more content -- import: <package-n> more content -- end: ds.page
-- import: <package-1> -- import: <package-2> ... -- import: <package-n> -- ds.page: title page content goes here -- end: ds.page
Advantages of exporting components over wrapping them
using-export: Use export for wrapper component definitions during ImportWhen we create component definitions which only refer to different component defined in another package. In such cases, where the component definition is just a wrapper definition of a component defined in another package, then using export feature while importing that package is recommended.
It reduces line of codes and readability.
Sample Scenario:
For documentations we usedoc-site package. In this package we refer the components like markdown, h0, h1, h2 and h3 from another package called typography package. One way is to create components in the doc-site and refer to these components in typography package.-- import: fastn-community.github.io/typography as tf ;; code goes here -- component markdown: caption or body body: -- tf.markdown: $markdown.body -- end: markdown -- component h1: caption title: optional body body: optional string id: -- tf.h1: $h1.title id: $h1.id $h1.body -- end: h1
-- import: fastn-community.github.io/typography as tf export: markdown, h1
Getting Help
Have a question or need help?
Visit our GitHub Q&A discussion to get answers and subscribe to it to stay tuned.
Join our Discord channel and share your thoughts, suggestion, question etc.
Connect with our community!Found an issue?
Quick links:
Join us
We welcome you to join our Discord community today.
We are trying to create the language for human beings and we do not believe it would be possible without your support. We would love to hear from you.
