misc(v2): clean up comments in code (#2294)

This commit is contained in:
Yangshun Tay 2020-02-18 21:29:23 +08:00 committed by GitHub
parent d7f3dff6e6
commit 996b115199
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
45 changed files with 234 additions and 155 deletions

View file

@ -12,7 +12,7 @@ import createSitemap from './createSitemap';
import {LoadContext, Props} from '@docusaurus/types';
const DEFAULT_OPTIONS: PluginOptions = {
cacheTime: 600 * 1000, // 600 sec - cache purge period
cacheTime: 600 * 1000, // 600 sec - cache purge period.
changefreq: 'weekly',
priority: 0.5,
};
@ -27,14 +27,14 @@ export default function pluginSitemap(
name: 'docusaurus-plugin-sitemap',
async postBuild({siteConfig, routesPaths, outDir}: Props) {
// Generate sitemap
// Generate sitemap.
const generatedSitemap = createSitemap(
siteConfig,
routesPaths,
options,
).toString();
// Write sitemap file
// Write sitemap file.
const sitemapPath = path.join(outDir, 'sitemap.xml');
fs.writeFile(sitemapPath, generatedSitemap, err => {
if (err) {