\n\n \n\nFragy is a Vue-based, dynamically rendered page lightweight blogging framework, we are committed to bringing the most agile and free experience to users.\n\n## 🔧 Usage\n\n### 🖥 For webmaster\n\nInstall `fragy-cli` with `npm` (at least v7):\n\n```bash\nnpm install fragy-cli -g\n```\n\n**Notice that you need at least Node.js `v14.5.0` to run the command line tool.**\n\nAfter that, use `fragy-cli` to initialize your site in an empty folder.\n\n```bash\nfragy init\n```\n\nFollow the instructions and enter the necessary information, then the program will automatically perform the initialization.\n\nOnce the site has been initialized, you can create a new post by using the following command:\n\n```bash\nfragy create post\n```\n\nYou can find the post in `.fragy/posts`.\n\nOnce everything is ready, you can use the following command to build your site:\n\n```bash\nfragy build\n```\n\nThe bundled files are in the `dist` folder, you can deploy them directly.\n\nYou can also run the following command to preview your site locally:\n\n```bash\nfragy serve\n```\n\nFor convenience, pages will auto reload it self when you changed any related files like articles or the configuration.\n\n#### 🚀 GitHub Mode\n\nWe provide a serverless mode to generate meta files, it was called `GitHub Mode`.\n\nIn this mode, you don't need to generate meta of posts anymore, to build your own blog, you only need to build your site once, then push the files to one of your GitHub repository.\n\nTo use this mode, you need to be aware of these rules and restrictions:\n\n1. You must use `fragy setup github` to setup GitHub config or set the related options in `fragy.config.js` manually before the site build.\n\n2. In the options, you must specify the `base` of posts if your posts are not in `.fragy/posts`.\n\n3. The folder where the posts are stored needs to be flat in structure due to the limit of the GitHub API, posts in subdirectories will not be retrieved.\n\n4. For users who living in Mainland of China, you need to set `proxy` in the options. The proxy server will receive a request, the request url similar to `https://proxyserver.com/https%3A%2F%2Fapi.github.com%2Frepos%2Ffragyjs%2Ffragy%2Fcontents%2Fsrc`\n\n#### MarkVue\n\nWe used a library called [`MarkVue`](https://github.com/backrunner/markvue) to provide an ability which allows you write Vue 3 SFC.\n\nTo enable this feature, you can set `markvue.enable` to `true` in `fragy.config.js`.\n\nYou can wrap a SFC with ``, here's an example:\n\n```markdown\n# This is an article with Vue SFC\n\nHey, we can use Vue SFC here.\n\n## SFC Demo\n\n\n\n
\n \n
\n\n\n\n\n\n```\n\nWARNING: Enable this feature will enlarge the size of bundled files, because we must add the compiler of Vue SFC to the bundle, it will make the loading slower.\n\n## ✒ License\n\nMIT\n","readmeFilename":"README.md","description":"
![](\"https://github.com/fragyjs/fragy/blob/main/assets/logo.png?raw=true\"){kind=logo}
![](\"./assets/icon-text-dark.svg\"){kind=icon}