https://github.com/imcuttle/react-router-sitemap-builder
react-router-sitemap-builder
https://github.com/imcuttle/react-router-sitemap-builder
Last synced: 8 months ago
JSON representation
react-router-sitemap-builder
- Host: GitHub
- URL: https://github.com/imcuttle/react-router-sitemap-builder
- Owner: imcuttle
- Created: 2017-02-10T15:49:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-01-07T15:01:06.000Z (over 4 years ago)
- Last Synced: 2025-04-13T02:46:12.122Z (over 1 year ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React-Router Sitemap Builder
Because of Server Side Render based on react react-router, We need SEO.
then **Sitemap Builder** Build `sitemap.txt` for SEO.
## Usage
```bash
npm install --save react-router-sitemap-builder
```
- router.js
```javascript
// router.js
import { Router, Route, IndexRoute, Redirect, IndexRedirect } from 'react-router'
import React from 'react';
export default (
)
```
- sitemap-builder.js
```javascript
import router from './router'
import siteMapBuilder, {getSites} from 'react-router-sitemap-builder'
getSites(router);
/*
[ '/',
'/test',
'/posts',
'/posts/*',
'/article/*',
'/tags/*',
'/tags/pages',
'/tags/pages/*',
'/archive',
'/archive/*' ]
*/
/* router, prefix, save_to_where */
sitemapBuilder(router, 'http://example.com', __dirname+'/sitemap.txt');
/* return true of false */
```
- sitemap.txt
```text
http://example.com/
http://example.com/test
http://example.com/posts
http://example.com/posts/*
http://example.com/article/*
http://example.com/tags/*
http://example.com/tags/pages
http://example.com/tags/pages/*
http://example.com/archive
http://example.com/archive/*
```
## Updates
[Updates](Updates.md)
## Development
**After `git clone`**
```
npm install babel-node babel
npm install && npm test
npm run dev # running babel
```
## License
MIT License
Copyright (c) 2017 CongYu
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.