mirror of
https://github.com/PacFactory/Docs-Exporter-Nextjs.git
synced 2025-12-20 11:41:06 -05:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f7d2cfa3bb | ||
|
|
746fec26bc | ||
|
|
b179050661 | ||
|
|
7a5a6fd13b | ||
|
|
b1322e5f37 | ||
|
|
835b60ee41 |
40
CONTRIBUTING.md
Normal file
40
CONTRIBUTING.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# Contributing to Nextjs Documentation PDF Generator
|
||||||
|
|
||||||
|
Thank you for your interest in contributing to this project!
|
||||||
|
|
||||||
|
## License Notice
|
||||||
|
By contributing to this project, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0.
|
||||||
|
|
||||||
|
## How to Contribute
|
||||||
|
1. Fork the repository
|
||||||
|
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
|
||||||
|
3. Make your changes
|
||||||
|
4. Add appropriate copyright notices to any new files:
|
||||||
|
```python
|
||||||
|
"""
|
||||||
|
Copyright (C) 2024 PacFactory
|
||||||
|
This file is part of Nextjs Documentation PDF Generator.
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
"""
|
||||||
|
```
|
||||||
|
5. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
|
||||||
|
6. Push to the branch (`git push origin feature/AmazingFeature`)
|
||||||
|
7. Open a Pull Request
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
- Be respectful of others
|
||||||
|
- Focus on constructive feedback
|
||||||
|
- Follow the AGPL-3.0 license requirements
|
||||||
|
|
||||||
|
## Development Guidelines
|
||||||
|
1. Maintain clear attribution of original work
|
||||||
|
2. Document all significant changes
|
||||||
|
3. Ensure source code remains accessible
|
||||||
|
4. Maintain compatibility with AGPL-3.0 requirements
|
||||||
|
|
||||||
|
## Questions?
|
||||||
|
If you have questions about licensing or contribution requirements, please open an issue.
|
||||||
@@ -31,6 +31,7 @@ Fork of the original [Docs-Exporter](https://github.com/Riyooo/Docs-Exporter). T
|
|||||||
- `playwright`
|
- `playwright`
|
||||||
- `gitpython`
|
- `gitpython`
|
||||||
- Ensure you have Playwright installed and configured:
|
- Ensure you have Playwright installed and configured:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install playwright
|
pip install playwright
|
||||||
playwright install
|
playwright install
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ Nextjs Documentation PDF Generator
|
|||||||
Modified version of Docs-Exporter for Astro documentation
|
Modified version of Docs-Exporter for Astro documentation
|
||||||
|
|
||||||
Original work Copyright (C) 2024 Riyooo
|
Original work Copyright (C) 2024 Riyooo
|
||||||
Modified work Copyright (C) 2024 PacNPal
|
Modified work Copyright (C) 2024 PacFactory
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
This program is free software: you can redistribute it and/or modify
|
||||||
it under the terms of the GNU Affero General Public License as published by
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
@@ -42,11 +42,11 @@ def get_license_notice():
|
|||||||
return """
|
return """
|
||||||
This PDF was generated by Nextjs Documentation PDF Generator
|
This PDF was generated by Nextjs Documentation PDF Generator
|
||||||
Original work Copyright (C) 2024 Riyooo
|
Original work Copyright (C) 2024 Riyooo
|
||||||
Modified work Copyright (C) 2024 PacNPal
|
Modified work Copyright (C) 2024 PacFactory
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
This program is free software: you can redistribute it and/or modify
|
||||||
it under the terms of the GNU Affero General Public License version 3.
|
it under the terms of the GNU Affero General Public License version 3.
|
||||||
Source code is available at: https://github.com/pacnpal/Docs-Exporter
|
Source code is available at: https://github.com/PacFactory/Docs-Exporter
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def add_license_page(html_content):
|
def add_license_page(html_content):
|
||||||
@@ -57,7 +57,7 @@ def add_license_page(html_content):
|
|||||||
<pre style="white-space: pre-wrap; font-family: monospace;">
|
<pre style="white-space: pre-wrap; font-family: monospace;">
|
||||||
{get_license_notice()}
|
{get_license_notice()}
|
||||||
</pre>
|
</pre>
|
||||||
<p>Complete source code for this program is available at: https://github.com/pacnpal/Docs-Exporter</p>
|
<p>Complete source code for this program is available at: https://github.com/PacFactory/Docs-Exporter</p>
|
||||||
<p>This program comes with ABSOLUTELY NO WARRANTY. This is free software, and you
|
<p>This program comes with ABSOLUTELY NO WARRANTY. This is free software, and you
|
||||||
are welcome to redistribute it under certain conditions. See the GNU Affero General
|
are welcome to redistribute it under certain conditions. See the GNU Affero General
|
||||||
Public License version 3 for details.</p>
|
Public License version 3 for details.</p>
|
||||||
@@ -360,7 +360,7 @@ if __name__ == "__main__":
|
|||||||
clone_repo(repo_url, branch, docs_dir, repo_dir)
|
clone_repo(repo_url, branch, docs_dir, repo_dir)
|
||||||
print(f"""
|
print(f"""
|
||||||
Nextjs Documentation PDF Generator v1.0.0
|
Nextjs Documentation PDF Generator v1.0.0
|
||||||
Copyright (C) 2024 PacNPal
|
Copyright (C) 2024 PacFactory
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details see the LICENSE file.
|
This program comes with ABSOLUTELY NO WARRANTY; for details see the LICENSE file.
|
||||||
This is free software, and you are welcome to redistribute it
|
This is free software, and you are welcome to redistribute it
|
||||||
under certain conditions; see the LICENSE file for details.
|
under certain conditions; see the LICENSE file for details.
|
||||||
|
|||||||
Reference in New Issue
Block a user