diff --git a/docs/import.md b/docs/import.md new file mode 100644 index 0000000..d9072d5 --- /dev/null +++ b/docs/import.md @@ -0,0 +1,33 @@ +# Importing existing files to standard.site records + +The sitebase import commands allow you to import existing static site content into `standard.site` records in your PDS. + +## Requirements for importing + +- File(s) targeted must be either markdown or html, with YAML-formatter frontmatter +- Must have `contentType`, `title`, `path` and `date` properties + - Make these are specifiable in import CLI flags + - Ex: `--titleProp=title`, `--publishedAtProp=date`, `--pathProp=route` + - `--contentType=(markdown|html)` +- Also optionally support `--descriptionProp`, and `--tagsProp` + +## Import process + +- Use the cli [sitebase doc import](./cli.md) command. + +*** + +# TODO + +- Refine this doc, make it nicer +- Ensure the command doc in ./cli.md aligns + +# QUESTIONS + +### Support both `doc import` and `pub import`? + +Just worry about `doc import` for now. It can target multiple files if needed. + +### Do pretty much all SSGs work with files that have frontmatter data? I think so! + +Enough so that I'm not worried about outliers